Skip to content

Commit 4980065

Browse files
committed
docs: Contribution information
Fixes assert-rs#22
1 parent a86635e commit 4980065

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

CONTRIBUTING.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributing to predicates-rs
2+
3+
Thanks for wanting to contribute! There are many ways to contribute and we
4+
appreciate any level you're willing to do.
5+
6+
## Feature Requests
7+
8+
Need some new functionality to help? You can let us know by opening an [issue][new issue]. It's helpful to look through [all
9+
issues][all issues] in case its already being talked about.
10+
11+
## Bug Reports
12+
13+
Please let us know about what problems you run into, whether in behavior or
14+
ergonomics of API. You can do this by opening an [issue][new issue].. It's
15+
helpful to look through [all issues][all issues] in case its already being
16+
talked about.
17+
18+
## Pull Requests
19+
20+
Looking for an idea? Check our [issues][issues]. If it's look more open ended,
21+
it is probably best to post on the issue how you are thinking of resolving the
22+
issue so you can get feedback early in the process. We want you to be
23+
successful and it can be discouraging to find out a lot of re-work is needed.
24+
25+
Already have an idea? It might be good to first [create an issue][new issue]
26+
to propose it so we can make sure we are aligned and lower the risk of having
27+
to re-work some of it and the discouragement that goes along with that.
28+
29+
### Process
30+
31+
When you first post a PR, it might be good to clean up the commit history. We
32+
recommend avoiding this during the PR to make it easier to review how feedback
33+
was handled. Once the commit is ready, we'll ask you to clean up the commit
34+
history. Once you let us know this is done, we can move forward with merging!
35+
If you are uncomfortable with these parts of git, let us know and we can help.
36+
37+
We ask that all new files have the copyright header. Please update the
38+
copyright year for files you are modifying.
39+
40+
As a heads up, we'll be running your PR through the following gauntlet:
41+
- warnings turned to compile errors
42+
- `cargo test`
43+
- `rustfmt`
44+
- `clippy`
45+
- `rustdoc`
46+
47+
Check out our [CI][travis] for more information.
48+
49+
## Releasing
50+
51+
When we're ready to release, a project owner should do the following
52+
- Determine what the next version is, according to semver
53+
- Bump version in a commit
54+
- Run `clog --setversion <X>.<Y>.<Z>`, touch up the log
55+
- Update the version in `Cargo.toml`
56+
- Update the dependency version in `src/lib.rs`
57+
- Update the dependency version in `README.md`
58+
- Tag the commit via `git tag -a v<X>.<Y>.<Z>`
59+
- `git push upstream master --tag v<X>.<Y>.<Z>`
60+
- Run `cargo publish` (run `cargo login` first if needed)
61+
62+
[issues]: https://github.com/assert-rs/predicates-rs/issues
63+
[new issue]: https://github.com/assert-rs/predicates-rs/issues/new
64+
[all issues]: https://github.com/assert-rs/predicates-rs/issues?utf8=%E2%9C%93&q=is%3Aissue
65+
[travis]: https://github.com/assert-rs/predicates-rs/blob/master/.travis.yml

0 commit comments

Comments
 (0)