-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add file detailing some general rules for contribution to the project
This change adds a new file, CONTRIBUTING.md, that details some generally applicable rules for the contribution to this project. It also links this file from the README.
- Loading branch information
Showing
2 changed files
with
30 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
The following rules generally apply for pull requests and code changes: | ||
|
||
**Submit Pull Requests to the `devel` branch** | ||
|
||
The `devel` branch is where experimental features reside. After some | ||
soak time they may be ported over to `master` and a release will be cut | ||
that includes them. | ||
|
||
**Keep documentation up-to-date** | ||
|
||
Please make an effort to keep the documentation up-to-date to the extent | ||
possible and necessary for the change at hand. That includes adjusting | ||
the [README](../README.md) and [`man` page](nitrocli.1) as well as | ||
regenerating the PDF rendered version of the latter by running `make | ||
doc`. | ||
|
||
**Blend with existing patterns and style** | ||
|
||
To keep the code as consistent as possible, please try not to diverge | ||
from the existing style used in a file. Specifically for Rust source | ||
code, use [`rustfmt`](https://github.com/rust-lang/rustfmt) and | ||
[`clippy`](https://github.com/rust-lang/rust-clippy) to achieve a | ||
minimum level of consistency and prevent known bugs, respectively. |