aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..b4a8af1f
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,16 @@
+# Contributing
+## New features
+New features should go through the [RFC process][rfcs] before a Pull Request is made to this repository.
+
+[rfcs](https://github.com/rtic-rs/rfcs)
+
+## Bugs
+Report bugs by creating an issue in this repository.
+
+## Pull Requests
+Please make pull requests against the master branch.
+
+Always use rebase instead of merge when bringing in changes from master to your feature branch.
+
+## Writing documentation
+Documentation improvements are always welcome. The source for the book is in `book/` and API documentation is generated from the source code.