aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authornils-grepit <nils.fitinghoff@grepit.se>2019-09-15 22:43:10 +0200
committernils-grepit <nils.fitinghoff@grepit.se>2019-09-15 22:43:10 +0200
commit476f29c4dde17e958dc2d3280acee3a19e87bb47 (patch)
treec8d6915e79e371ba776d0ee92072c1b8036075f0 /CONTRIBUTING.md
parentc14f7d1ce90ad4957801336cefe65b7fa82fe63f (diff)
add CONTRIBUTING.md and link to Matrix room
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 0000000..b9d2f49
--- /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/rtfm-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.