Merge pull request #28 from epage/misc

Documentation and Licensing

Author: epage

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,18 @@
+<!-- If you want to report a bug, please fill out the information below.
+Otherwise, feel free to remove these lines.-->
+
+
+<!-- Insert short summary -->
+
+I tried this code:
+
+<!-- Insert code sample -->
+
+I expected to see this happen:
+
+Instead this happened:
+
+## Meta
+
+predicates-rs version:
+`rustc --version --verbose`:

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,6 @@
+<!--
+Quick reminders:
+- Were tests written?
+- Is commit history clean?
+- Were copyright statements updated?
+-->

CONTRIBUTING.md

@@ -0,0 +1,67 @@
+# Contributing to predicates-rs
+
+Thanks for wanting to contribute! There are many ways to contribute and we
+appreciate any level you're willing to do.
+
+## Feature Requests
+
+Need some new functionality to help?  You can let us know by opening an
+[issue][new issue]. It's helpful to look through [all issues][all issues] in
+case its already being talked about.
+
+## Bug Reports
+
+Please let us know about what problems you run into, whether in behavior or
+ergonomics of API.  You can do this by opening an [issue][new issue]. It's
+helpful to look through [all issues][all issues] in case its already being
+talked about.
+
+## Pull Requests
+
+Looking for an idea? Check our [issues][issues]. If it's look more open ended,
+it is probably best to post on the issue how you are thinking of resolving the
+issue so you can get feedback early in the process. We want you to be
+successful and it can be discouraging to find out a lot of re-work is needed.
+
+Already have an idea?  It might be good to first [create an issue][new issue]
+to propose it so we can make sure we are aligned and lower the risk of having
+to re-work some of it and the discouragement that goes along with that.
+
+### Process
+
+When you first post a PR, we request that the the commit history get cleaned
+up.  We recommend avoiding this during the PR to make it easier to review how
+feedback was handled. Once the commit is ready, we'll ask you to clean up the
+commit history.  Once you let us know this is done, we can move forward with
+merging!  If you are uncomfortable with these parts of git, let us know and we
+can help.
+
+We ask that all new files have the copyright header.  Please update the
+copyright year for files you are modifying.
+
+As a heads up, we'll be running your PR through the following gauntlet:
+- warnings turned to compile errors
+- `cargo test`
+- `rustfmt`
+- `clippy`
+- `rustdoc`
+
+Check out our [CI][travis] for more information.
+
+## Releasing
+
+When we're ready to release, a project owner should do the following
+- Determine what the next version is, according to semver
+- Bump version in a commit
+  - Update CHANGELOG.md
+  - Update the version in `Cargo.toml`
+  - Update the dependency version in `src/lib.rs`
+  - Update the dependency version in `README.md`
+- Tag the commit via `git tag -am "v<X>.<Y>.<Z>" v<X>.<Y>.<Z>`
+- `git push upstream master --tag v<X>.<Y>.<Z>`
+- Run `cargo publish` (run `cargo login` first if needed)
+
+[issues]: https://github.com/assert-rs/predicates-rs/issues
+[new issue]: https://github.com/assert-rs/predicates-rs/issues/new
+[all issues]: https://github.com/assert-rs/predicates-rs/issues?utf8=%E2%9C%93&q=is%3Aissue
+[travis]: https://github.com/assert-rs/predicates-rs/blob/master/.travis.yml

README.md

@@ -25,7 +25,7 @@ Next, add this to your crate:
 ```rust
 extern crate predicates;
 
-use predicates::Predicate;
+use predicates::prelude::*;
 ```
 
 For more information on using predicates, look at the

src/boolean.rs

@@ -1,4 +1,4 @@
-// Copyright (c) 2017, Nick Stevens <[email protected]>
+// Copyright (c) 2018 The predicates-rs Project Developers.
 //
 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 // http://www.apache.org/license/LICENSE-2.0> or the MIT license

src/boxed.rs

@@ -1,4 +1,4 @@
-// Copyright (c) 2017, Nick Stevens <[email protected]>
+// Copyright (c) 2018 The predicates-rs Project Developers.
 //
 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 // http://www.apache.org/license/LICENSE-2.0> or the MIT license

src/constant.rs

@@ -1,4 +1,4 @@
-// Copyright (c) 2017, Nick Stevens <[email protected]>
+// Copyright (c) 2018 The predicates-rs Project Developers.
 //
 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 // http://www.apache.org/license/LICENSE-2.0> or the MIT license

src/function.rs

@@ -1,4 +1,4 @@
-// Copyright (c) 2017, Nick Stevens <[email protected]>
+// Copyright (c) 2018 The predicates-rs Project Developers.
 //
 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 // http://www.apache.org/license/LICENSE-2.0> or the MIT license

src/lib.rs

@@ -1,4 +1,4 @@
-// Copyright (c) 2017, Nick Stevens <[email protected]>
+// Copyright (c) 2018 The predicates-rs Project Developers.
 //
 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 // http://www.apache.org/license/LICENSE-2.0> or the MIT license

src/ord.rs

@@ -1,4 +1,4 @@
-// Copyright (c) 2017, Nick Stevens <[email protected]>
+// Copyright (c) 2018 The predicates-rs Project Developers.
 //
 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 // http://www.apache.org/license/LICENSE-2.0> or the MIT license

src/set.rs

@@ -1,4 +1,4 @@
-// Copyright (c) 2017, Nick Stevens <[email protected]>
+// Copyright (c) 2018 The predicates-rs Project Developers.
 //
 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
 // http://www.apache.org/license/LICENSE-2.0> or the MIT license