From 1e6fc74d4fcf7aba92d0b0a8dba15106eecbd1ae Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Fri, 6 Oct 2017 11:23:49 +0100 Subject: Add Code Style and some dev docs (#286) --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'CONTRIBUTING.md') 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). -- cgit v1.2.3