diff options
| author | Erik Johnston <erikj@jki.re> | 2017-10-06 11:23:49 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-06 11:23:49 +0100 |
| commit | 1e6fc74d4fcf7aba92d0b0a8dba15106eecbd1ae (patch) | |
| tree | 7bdb842ea153af24e617ad5b7891e7d06b8c7b31 /CONTRIBUTING.md | |
| parent | 5229dbf31068ad7973255a22374d4a115ee93fad (diff) | |
Add Code Style and some dev docs (#286)
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e5e4ca8f..00761f58 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,6 +3,19 @@ Everyone is welcome to contribute to Dendrite! We aim to make it as easy as possible to get started. +Please ensure that you sign off your contributions! See [Sign Off](#sign-off) +section below. + +## Getting up and running + +See [INSTALL.md](INSTALL.md) for instructions on setting up a running dev +instance of dendrite, and [CODE_STYLE.md](CODE_STYLE.md) for the code style +guide. + +We use `gb` for managing our dependencies, so `gb build` and `gb test` is how +to build dendrite and run the unit tests respectively. + + ## 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). |