Merge pull request #7 from iqlusion-io/contributing

Use Apache 2.0 license and clarify contribution guidelines

AUTHORS.md

@@ -0,0 +1,13 @@
+# Authors
+
+All code in the iqlusion crates repository is Copyright © 2018 iqlusion, except
+for contributions of individual authors below, who have agreed to license their
+contributions under the terms of the [Apache License, Version 2.0]
+(included in this repository in the toplevel [LICENSE] file).
+
+[Apache License, Version 2.0]: https://www.apache.org/licenses/LICENSE-2.0
+[LICENSE]: https://github.com/iqlusion-io/crates/blob/master/LICENSE
+
+* Yin Guanhao ([@sopium](https://github.com/sopium)): [tai64]
+
+[tai64]: https://github.com/iqlusion-io/crates/tree/master/tai64

CODE_OF_CONDUCT.md

@@ -55,8 +55,8 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
-complaints will be reviewed and investigated and will result in a response that
+reported by contacting the project team at [oss@iqlusion.io](mailto:oss@iqlusion.io).
+All complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
 Further details of specific enforcement policies may be posted separately.

CONTRIBUTING.md

@@ -0,0 +1,60 @@
+# Contributing
+
+Thank you for your interest in contributing to the [iqlusion crates] repository!
+
+[iqlusion crates]: https://github.com/iqlusion-io/crates
+
+To contribute to this repository, here is all you need to do:
+
+1. Review [CODE_OF_CONDUCT.md]
+2. Fork the project on GitHub and create a commit adding yourself to [AUTHORS.md]
+3. Create one or more additional commits including your contributions, then open
+   a [pull request] along with the commit adding yourself to [AUTHORS.md].
+
+[CODE_OF_CONDUCT.md]: https://github.com/iqlusion-io/crates/blob/master/CODE_OF_CONDUCT.md
+[AUTHORS.md]: https://github.com/iqlusion-io/crates/blob/master/AUTHORS.md
+[pull request]: https://help.github.com/articles/about-pull-requests/
+
+## Code of Conduct
+
+First, we please ask you to review the [CODE_OF_CONDUCT.md], as we would like to
+make this a friendly, cordial, and harassment-free project where anyone can
+contribute regardless of race, gender, or sexual orientation.
+
+If you observe harassment which you do not think is being addressed, please
+[contact us] and we will seek to remedy the situation.
+
+[contact us]: mailto:oss@iqlusion.io
+
+## Add Yourself to AUTHORS.md
+
+Before we can accept a PR, we need you to add yourself to the [AUTHORS.md] file,
+along with a statement that you are willing to license your contributions under
+the terms of the [Apache License, Version 2.0] (included in this repository in
+the toplevel [LICENSE] file).
+
+[Apache License, Version 2.0]: https://www.apache.org/licenses/LICENSE-2.0
+[LICENSE]: https://github.com/iqlusion-io/crates/blob/master/LICENSE
+
+To do this, edit the [AUTHORS.md] file, inserting your name in the list of
+contributors (in rougly alphabetical order by last name, preferably) along with
+the name of the crate or crates you are contributing to.
+
+Commit the [AUTHORS.md] file alone (i.e. do not modify other files in the same
+commit, although it is fine to include this commit as part of your first PR to
+the project), and use the following commit message:
+
+```
+AUTHORS.md: adding [MY GITHUB USERNAME] and licensing my contributions
+
+I, [LEGAL NAME HERE], hereby agree to license all contributions I make to
+this project under the terms of the Apache License, Version 2.0.
+```
+
+Please replace `[MY GITHUB USERNAME]` with the GitHub username you are sending
+the PR from, including the `@` symbol (e.g. `@defunkt`), and also replacing
+`[LEGAL NAME HERE]` with your full legal name.
+
+If you have concerns about including your legal name in this file but would
+still like to contribute, please [contact us] and we can discuss other potential
+arrangements.

Cargo.toml

@@ -1,4 +1,5 @@
 [workspace]
+license = "Apache-2.0"
 members = [
     "librpm-sys",
     "tai64"

README.md

@@ -1,6 +1,31 @@
 # iqlusion crates 📦
 
-Crates... for Rust... from iqlusion!
+[![Build Status][build-image]][build-link]
+[![Apache 2.0 Licensed][license-image]][license-link]
+
+[build-image]: https://circleci.com/gh/iqlusion-io/crates.svg?style=shield
+[build-link]: https://circleci.com/gh/iqlusion-io/crates
+[license-image]: https://img.shields.io/badge/license-Apache2.0-blue.svg
+[license-link]: https://github.com/iqlusion-io/crates/blob/master/LICENSE
+
+This repository contains a set of Apache 2.0-licensed packages (a.k.a.  "crates")
+for the [Rust](https://www.rust-lang.org/) programming language, contributed
+to the community by [iqlusion](https://www.iqlusion.io).
+
+If you are interested in contributing to this repository, please make sure to
+read the [CONTRIBUTING.md] and [CODE_OF_CONDUCT.md] files first.
+
+[CONTRIBUTING.md]: https://github.com/iqlusion-io/crates/blob/master/CONTRIBUTING.md
+[CODE_OF_CONDUCT.md]: https://github.com/iqlusion-io/crates/blob/master/CODE_OF_CONDUCT.md
+
+## Crate Descriptions
+
+This repository contains the following crates:
+
+* [librpm-sys:](https://github.com/iqlusion-io/crates/tree/master/librpm-sys)
+  bindgen wrapper to librpm (RedHat Package Manager library)
+* [tai64:](https://github.com/iqlusion-io/crates/tree/master/tai64)
+  TAI64(N) timestamp format (Temps Atomique International)
 
 ## License
 

librpm-sys/Cargo.toml

@@ -2,7 +2,7 @@
 name        = "librpm-sys"
 description = "FFI bindings for librpm: the RedHat Package Manager (RPM) library"
 version     = "0.0.1"
-license     = "MIT/Apache-2.0"
+license     = "Apache-2.0"
 authors     = ["Tony Arcieri <tony@iqlusion.io>"]
 categories  = ["external-ffi-bindings", "os"]
 keywords    = ["rpm", "linux", "redhat", "fedora", "centos"]

librpm-sys/README.md

@@ -1,7 +1,28 @@
-# librpm-sys: bindgen wrapper to librpm
+# librpm-sys: bindgen wrapper for librpm (RedHat Package Manager library)
 
-This crate provides a raw bindgen wrapper to the librpm C library, which
-provides a low-level API for interacting with the details of RPM files.
+[![Crate][crate-image]][crate-link] [![Build Status][build-image]][build-link] [![Apache 2.0 Licensed][license-image]][license-link]
 
-This crate isn't intended to be used directly, but instead provides the
-low-level unsafe binding used by the higher level librpm crate.
+[crate-image]: https://img.shields.io/crates/v/librpm-sys.svg
+[crate-link]: https://crates.io/crates/librpm-sys
+[build-image]: https://circleci.com/gh/iqlusion-io/crates.svg?style=shield
+[build-link]: https://circleci.com/gh/iqlusion-io/crates
+[license-image]: https://img.shields.io/badge/license-Apache2.0-blue.svg
+[license-link]: https://github.com/iqlusion-io/crates/blob/master/LICENSE
+
+This crate uses bindgen to generate an unsafe FFI wrapper for the librpm C
+library, which provides an API for interacting with the RedHat Package
+Manager (RPM) and **.rpm** files.
+
+This crate isn't intended to be used directly, but instead provides an unsafe,
+low-level binding used by the higher level librpm crate, which aims to provide
+a higher-level wrapper which can be used from safe Rust code.
+
+## License
+
+The **librpm-sys** crate is distributed under the terms of the Apache License
+(Version 2.0).
+
+See [LICENSE] file in the `iqlusion-io/crates` toplevel directory for more
+information.
+
+[LICENSE]: https://github.com/iqlusion-io/crates/blob/master/LICENSE

tai64/Cargo.toml

@@ -1,9 +1,9 @@
 [package]
 name        = "tai64"
-description = "TAI64(N) timestamp support for Rust"
+description = "TAI64 and TAI64N (i.e. Temps Atomique International) timestamp support for Rust"
 version     = "0.2.0" # Also update html_root_url in lib.rs when bumping this
 authors     = ["sopium <sopium@mysterious.site>", "Tony Arcieri <bascule@gmail.com>"]
-license     = "MIT/Apache-2.0"
+license     = "Apache-2.0"
 homepage    = "https://github.com/tarcieri/tai64-rs/"
 repository  = "https://github.com/tarcieri/tai64-rs/tree/master/src"
 readme      = "README.md"

tai64/README.md

@@ -1,11 +1,13 @@
-# TAI64(N) for Rust [![Crate][crate-image]][crate-link] [![Docs][docs-image]][docs-link] [![Build Status][build-image]][build-link]
+# TAI64(N) for Rust [![Crate][crate-image]][crate-link] [![Docs][docs-image]][docs-link] [![Build Status][build-image]][build-link] [![Apache 2.0 Licensed][license-image]][license-link]
 
 [crate-image]: https://img.shields.io/crates/v/tai64.svg
 [crate-link]: https://crates.io/crates/tai64
 [docs-image]: https://docs.rs/tai64/badge.svg
 [docs-link]: https://docs.rs/tai64/
-[build-image]: https://travis-ci.org/tarcieri/tai64-rs.svg?branch=master
-[build-link]: https://travis-ci.org/tarcieri/tai64-rs
+[build-image]: https://circleci.com/gh/iqlusion-io/crates.svg?style=shield
+[build-link]: https://circleci.com/gh/iqlusion-io/crates
+[license-image]: https://img.shields.io/badge/license-Apache2.0-blue.svg
+[license-link]: https://github.com/iqlusion-io/crates/blob/master/LICENSE
 
 An implementation of the [TAI64(N)] (*Temps Atomique International*) timestamp
 format in Rust. Supports converting to/from Rust's built-in [SystemTime] type
@@ -21,7 +23,10 @@ enabled.
 
 ## License
 
-**tai64-rs** is distributed under the terms of both the MIT license and the
-Apache License (Version 2.0).
+The **tai64** crate is distributed under the terms of the Apache License
+(Version 2.0).
 
-See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.
+See [LICENSE] file in the `iqlusion-io/crates` toplevel directory for more
+information.
+
+[LICENSE]: https://github.com/iqlusion-io/crates/blob/master/LICENSE