2017-10-06 01:11:51 +00:00
|
|
|
# Contributing to Dendrite
|
|
|
|
|
|
|
|
|
|
Everyone is welcome to contribute to Dendrite! We aim to make it as easy as
|
|
|
|
|
possible to get started.
|
|
|
|
|
|
2017-10-06 10:23:49 +00:00
|
|
|
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.
|
|
|
|
|
|
2019-05-22 09:44:25 +00:00
|
|
|
As of May 2019, we're not using `gb` anymore, which is the tool we had been
|
|
|
|
|
using for managing our dependencies. We're now using Go modules. To build
|
|
|
|
|
Dendrite, run the `build.sh` script at the root of this repository (which runs
|
|
|
|
|
`go install` under the hood), and to run unit tests, run `go test ./...` (which
|
|
|
|
|
should pick up any unit test and run it). There are also [scripts](scripts) for
|
|
|
|
|
[linting](scripts/find-lint.sh) and doing a [build/test/lint
|
|
|
|
|
run](scripts/build-test-lint.sh).
|
2017-10-06 10:23:49 +00:00
|
|
|
|
|
|
|
|
|
2017-10-06 01:11:51 +00:00
|
|
|
## Picking Things To Do
|
|
|
|
|
|
2017-10-11 17:08:35 +00:00
|
|
|
If you're new then feel free to pick up an issue labelled [good first issue](https://github.com/matrix-org/dendrite/labels/good%20first%20issue).
|
2017-10-06 01:11:51 +00:00
|
|
|
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
|
2017-10-11 17:08:35 +00:00
|
|
|
[help wanted](https://github.com/matrix-org/dendrite/labels/help%20wanted), these
|
2017-10-06 01:11:51 +00:00
|
|
|
are often slightly larger or more complicated pieces of work but are hopefully
|
|
|
|
|
nonetheless fairly well-contained.
|
|
|
|
|
|
2017-10-11 17:08:35 +00:00
|
|
|
We ask people who are familiar with Dendrite to leave the [good first issue](https://github.com/matrix-org/dendrite/labels/good%20first%20issue)
|
2017-10-06 01:11:51 +00:00
|
|
|
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
|
2019-01-28 10:15:33 +00:00
|
|
|
Matrix [#dendrite-dev:matrix.org](https://matrix.to/#/#dendrite-dev:matrix.org)
|
2017-10-06 01:11:51 +00:00
|
|
|
where we're happy to help.
|
|
|
|
|
|
2019-01-28 10:15:33 +00:00
|
|
|
For more general questions please use [#dendrite:matrix.org](https://matrix.to/#/#dendrite:matrix.org).
|
2017-10-06 01:11:51 +00:00
|
|
|
|
|
|
|
|
## 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).
|
