|
2 | 2 |
|
3 | 3 | This document aims to get you started with contributing to this repo!
|
4 | 4 |
|
5 |
| -- [1. Who can contribute to Synapse?](#1-who-can-contribute-to-synapse) |
6 |
| -- [2. What do I need?](#2-what-do-i-need) |
7 |
| -- [3. Get the source.](#3-get-the-source) |
8 |
| -- [4. Install the dependencies](#4-install-the-dependencies) |
9 |
| - * [Under Unix (macOS, Linux, BSD, ...)](#under-unix-macos-linux-bsd-) |
10 |
| - * [Under Windows](#under-windows) |
11 |
| -- [5. Get in touch.](#5-get-in-touch) |
12 |
| -- [6. Pick an issue.](#6-pick-an-issue) |
13 |
| -- [7. Turn coffee and documentation into code and documentation!](#7-turn-coffee-and-documentation-into-code-and-documentation) |
14 |
| -- [8. Test, test, test!](#8-test-test-test) |
15 |
| - * [Run the linters.](#run-the-linters) |
16 |
| - * [Run the unit tests.](#run-the-unit-tests) |
17 |
| - * [Run the integration tests.](#run-the-integration-tests) |
18 |
| -- [9. Submit your patch.](#9-submit-your-patch) |
19 |
| - * [Changelog](#changelog) |
20 |
| - + [How do I know what to call the changelog file before I create the PR?](#how-do-i-know-what-to-call-the-changelog-file-before-i-create-the-pr) |
21 |
| - + [Debian changelog](#debian-changelog) |
22 |
| - * [Sign off](#sign-off) |
23 |
| -- [10. Turn feedback into better code.](#10-turn-feedback-into-better-code) |
24 |
| -- [11. Find a new issue.](#11-find-a-new-issue) |
25 |
| -- [Notes for maintainers on merging PRs etc](#notes-for-maintainers-on-merging-prs-etc) |
26 |
| -- [Conclusion](#conclusion) |
27 |
| - |
28 | 5 | # 1. Who can contribute to Synapse?
|
29 | 6 |
|
30 | 7 | Everyone is welcome to contribute code to [matrix.org
|
@@ -95,9 +72,9 @@ Fix your favorite problem or perhaps find a [Good First Issue](https://github.co
|
95 | 72 | to work on.
|
96 | 73 |
|
97 | 74 |
|
98 |
| -# 7. Turn coffee and documentation into code and documentation! |
| 75 | +# 7. Turn coffee into code and documentation! |
99 | 76 |
|
100 |
| -There is a growing amount of documentation located in the [`docs`](docs) |
| 77 | +There is a growing amount of documentation located in the `docs` |
101 | 78 | directory, with a rendered version [available online](https://matrix-org.github.io/synapse).
|
102 | 79 | This documentation is intended primarily for sysadmins running their
|
103 | 80 | own Synapse instance, as well as developers interacting externally with
|
|
0 commit comments