aboutsummaryrefslogtreecommitdiff
path: root/doc/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDaniel Mueller <deso@posteo.net>2020-04-04 15:32:14 -0700
committerDaniel Mueller <deso@posteo.net>2020-04-04 15:32:14 -0700
commit681cc8882f7995407c33eb48730daaa901074460 (patch)
treec865f6c4a34e11af685889a09d95f3225e54a16c /doc/CONTRIBUTING.md
parentd0d9683df8398696147e7ee1fcffb2e4e957008c (diff)
downloadnitrocli-681cc8882f7995407c33eb48730daaa901074460.tar.gz
nitrocli-681cc8882f7995407c33eb48730daaa901074460.tar.bz2
Move nitrocli source code into repository root
Now that all vendored dependencies have been removed, this change moves the program's source code from the nitrocli/ directory into the root of the repository.
Diffstat (limited to 'doc/CONTRIBUTING.md')
-rw-r--r--doc/CONTRIBUTING.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md
new file mode 100644
index 0000000..3ebdfce
--- /dev/null
+++ b/doc/CONTRIBUTING.md
@@ -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.