Skip to content
This repository was archived by the owner on Dec 29, 2021. It is now read-only.

Commit 97d9f2a

Browse files
committed
docs: Document contributing expectations
Fixes #64
1 parent 1b31307 commit 97d9f2a

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
Thanks for wanting to contribute!
2+
3+
Feel free to create issues or make pull requests, we'll try to quickly review them.
4+
5+
If you need to reach out to us, find a relevant [issue](https://github.com/killercup/assert_cli/issues) or open a new one.
6+
7+
# Issues
8+
9+
Some helpful pieces of information when reporting issues
10+
* assert_cli version
11+
* rust version
12+
* OS and version
13+
14+
# Pull Requests
15+
16+
## Project Ideas
17+
18+
If you're looking for things to do check out the [open issues](https://github.com/killercup`/assert_cli/issues).
19+
Or take a grep through [all TODO comments](https://github.com/killercup/assert_cli/search?q=TODO) in the code and feel free to help us out there!
20+
21+
## Best Practices
22+
23+
We appreciate your help as-is. We'd love to help you through the process for contributing. We have some suggestions to help make things go more smoothly.
24+
25+
Before spending too much time on a PR, consider opening an issue so we can make sure we're aligned on how the problem should be solved.
26+
27+
🌈 **Here's a checklist for the perfect pull request:**
28+
- [ ] Make sure existing tests still work by running `cargo test` locally.
29+
- [ ] Add new tests for any new feature or regression tests for bugfixes.
30+
- [ ] Install [Clippy](https://github.com/Manishearth/rust-clippy) and run `rustup run nightly cargo clippy` to catch common mistakes (will be checked by Travis)
31+
32+
# Releasing
33+
34+
When we're ready to release, a project owner should do the following
35+
- Determine what the next version is, according to semver
36+
- Update the version in `Cargo.toml` and in the `README.md` and commit
37+
- Run `git tag v<X>.<Y>.<Z>`
38+
- Push all of this to `master`
39+
- Create a github release
40+
- Identify what fixes, features, and breaking changes are in the release.
41+
- Run `cargo publish` (run `cargo login` first if needed)

0 commit comments

Comments
 (0)