cobalt.rs/CONTRIBUTING.md

27 lines
1.8 KiB
Markdown
Raw Normal View History

2015-11-07 08:37:25 +00:00
Thanks for contributing! :snowman:
Feel free to create issues and make pull requests, we'll try to quickly review them.
2016-02-14 10:31:00 +00:00
If you're looking for things to do check out the [open issues](https://github.com/cobalt-org/cobalt.rs/issues), especially those with the [easy](https://github.com/cobalt-org/cobalt.rs/issues?q=is%3Aissue+is%3Aopen+label%3Aeasy) flag. Or take a grep through [all TODO comments](https://github.com/cobalt-org/cobalt.rs/search?q=TODO) in the code and feel free to help us out there!
2016-01-15 23:19:50 +00:00
2017-02-02 20:12:46 +00:00
🌈 **Here's a checklist for the perfect pull request:**
- [ ] Make sure existing tests still work by running `cargo test` locally.
- [ ] Add new tests for any new feature or regression tests for bugfixes.
- [ ] Install [Clippy](https://github.com/Manishearth/rust-clippy) and run `rustup run nightly cargo clippy` to catch common mistakes (will be checked by Travis)
- [ ] Install [Rustfmt](https://github.com/rust-lang-nursery/rustfmt) and run `cargo fmt` to format your code (will also be checked by Travis)
2015-11-07 08:37:25 +00:00
If you need assistance, you can join the `#cobalt` channel on `irc.mozilla.org` or the Gitter chat [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cobalt-org/cobalt.rs)
We want you to feel safe and welcome and will enforce the [The Rust Code of Conduct](https://www.rust-lang.org/conduct.html) on all communication platforms of this project.
2016-02-14 10:31:00 +00:00
Please contact [@johannhof](https://github.com/johannhof) for questions or in cases of violation.
2017-11-08 03:13:26 +00:00
# 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
- Run `clog --setversion <X>.<Y>.<Z>`, touch up the log
- Update the version in `Cargo.toml`
- Run `cargo check` to update `Cargo.lock`
2019-11-27 23:13:39 +00:00
- Run `cargo release <level>`