aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorErik Johnston <erikj@jki.re>2017-10-06 02:11:51 +0100
committerRichard van der Hoff <github@rvanderhoff.org.uk>2017-10-06 02:11:51 +0100
commit5229dbf31068ad7973255a22374d4a115ee93fad (patch)
tree90c173aad0a20bde9bbf9dac1b42b7c4fdd50c8d /CONTRIBUTING.md
parentbcf58fad84bf53b6a6cf13a8d11bd46d82cc3bab (diff)
Create CONTRIBUTING.md (#264)
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..e5e4ca8f
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,32 @@
+# Contributing to Dendrite
+
+Everyone is welcome to contribute to Dendrite! We aim to make it as easy as
+possible to get started.
+
+## Picking Things To Do
+
+If you're new then feel free to pick up an issue labelled [easy](https://github.com/matrix-org/dendrite/labels/easy).
+These should be well-contained, small pieces of work that can be picked up to
+help you get familiar with the code base.
+
+Once you're comfortable with hacking on Dendrite there are issues lablled as
+[help-wanted](https://github.com/matrix-org/dendrite/labels/help-wanted), these
+are often slightly larger or more complicated pieces of work but are hopefully
+nonetheless fairly well-contained.
+
+We ask people who are familiar with Dendrite to leave the [easy](https://github.com/matrix-org/dendrite/labels/easy)
+issues so that there is always a way for new people to come and get involved.
+
+## Getting Help
+
+For questions related to developing on Dendrite we have a dedicated room on
+Matrix [#dendrite-dev:matrix.org](https://riot.im/develop/#/room/#dendrite-dev:matrix.org)
+where we're happy to help.
+
+For more general questions please use [#dendrite:matrix.org](https://riot.im/develop/#/room/#dendrite:matrix.org).
+
+## Sign off
+
+We ask that everyone who contributes to the project signs off their
+contributions, in accordance with the [DCO](https://github.com/matrix-org/matrix-doc/blob/master/CONTRIBUTING.rst#sign-off).
+