diff options
| author | kegsay <kegan@matrix.org> | 2022-12-05 16:54:01 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-12-05 16:54:01 +0000 |
| commit | 75834783055b0c70f8b411d9c3741e57461832f0 (patch) | |
| tree | 31613dc32bd5f0e2310d8ec14f37b4788e30f873 /docs | |
| parent | b99349b18c28a1c27b5bd5df30853a3b7c689d02 (diff) | |
Update contributing guidelines (#2904)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/CONTRIBUTING.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 262a93a7..21b0e7ab 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -9,6 +9,28 @@ permalink: /development/contributing Everyone is welcome to contribute to Dendrite! We aim to make it as easy as possible to get started. + ## Contribution types + +We are a small team maintaining a large project. As a result, we cannot merge every feature, even if it +is bug-free and useful, because we then commit to maintaining it indefinitely. We will always accept: + - bug fixes + - security fixes (please responsibly disclose via security@matrix.org *before* creating pull requests) + +We will accept the following with caveats: + - documentation fixes, provided they do not add additional instructions which can end up going out-of-date, + e.g example configs, shell commands. + - performance fixes, provided they do not add significantly more maintenance burden. + - additional functionality on existing features, provided the functionality is small and maintainable. + - additional functionality that, in its absence, would impact the ecosystem e.g spam and abuse mitigations + - test-only changes, provided they help improve coverage or test tricky code. + +The following items are at risk of not being accepted: + - Configuration or CLI changes, particularly ones which increase the overall configuration surface. + +The following items are unlikely to be accepted into a main Dendrite release for now: + - New MSC implementations. + - New features which are not in the specification. + ## Sign off We require that everyone who contributes to the project signs off their contributions |