@@ -2,30 +2,6 @@ Welcome to Synapse
22
33This document aims to get you started with contributing to this repo!
44
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-twisted-trial )
17- * [ Run the integration tests (SyTest).] ( #run-the-integration-tests-sytest )
18- * [ Run the integration tests (Complement).] ( #run-the-integration-tests-complement )
19- - [ 9. Submit your patch.] ( #9-submit-your-patch )
20- * [ Changelog] ( #changelog )
21- + [ 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 )
22- + [ Debian changelog] ( #debian-changelog )
23- * [ Sign off] ( #sign-off )
24- - [ 10. Turn feedback into better code.] ( #10-turn-feedback-into-better-code )
25- - [ 11. Find a new issue.] ( #11-find-a-new-issue )
26- - [ Notes for maintainers on merging PRs etc] ( #notes-for-maintainers-on-merging-prs-etc )
27- - [ Conclusion] ( #conclusion )
28-
295# 1. Who can contribute to Synapse?
306
317Everyone is welcome to contribute code to [ matrix.org
@@ -35,7 +11,7 @@ follow a simple 'inbound=outbound' model for contributions: the act of
3511submitting an 'inbound' contribution means that the contributor agrees to
3612license the code under the same terms as the project's overall 'outbound'
3713license - in our case, this is almost always Apache Software License v2 (see
38- [ LICENSE] ( LICENSE ) ).
14+ [ LICENSE] ( https://github.com/matrix-org/synapse/blob/develop/ LICENSE) ).
3915
4016# 2. What do I need?
4117
@@ -98,17 +74,20 @@ to work on.
9874
9975# 7. Turn coffee and documentation into code and documentation!
10076
101- Synapse's code style is documented [ here] ( docs/code_style.md ) . Please follow
102- it, including the conventions for the [ sample configuration
103- file] ( docs/code_style.md#configuration-file-format ) .
77+ Synapse's code style is documented
78+ [ here] ( https://matrix-org.github.io/synapse/develop/code_style.html ) .
79+ Please follow it, including the conventions for the
80+ [ sample configuration file] ( https://matrix-org.github.io/synapse/develop/code_style.html#configuration-file-format ) .
10481
105- There is a growing amount of documentation located in the [ docs] ( docs )
82+ There is a growing amount of documentation located in the
83+ [ docs] ( https://github.com/matrix-org/synapse/tree/develop/docs )
10684directory. This documentation is intended primarily for sysadmins running their
107- own Synapse instance, as well as developers interacting externally with
108- Synapse. [ docs/dev] ( docs/dev ) exists primarily to house documentation for
109- Synapse developers. [ docs/admin_api] ( docs/admin_api ) houses documentation
110- regarding Synapse's Admin API, which is used mostly by sysadmins and external
111- service developers.
85+ own Synapse instance, as well as developers interacting externally with Synapse.
86+ [ docs/development] ( https://github.com/matrix-org/synapse/tree/develop/docs/development )
87+ exists primarily to house documentation for Synapse developers.
88+ [ docs/admin_api] ( https://github.com/matrix-org/synapse/tree/develop/docs/admin_api )
89+ houses documentation regarding Synapse's Admin API, which is used mostly by sysadmins
90+ and external service developers.
11291
11392If you add new files added to either of these folders, please use [ GitHub-Flavoured
11493Markdown] ( https://guides.github.com/features/mastering-markdown/ ) .
@@ -431,7 +410,7 @@ By now, you know the drill!
431410# Notes for maintainers on merging PRs etc
432411
433412There are some notes for those with commit access to the project on how we
434- manage git [ here] ( docs/ development/git.md ) .
413+ manage git [ here] ( https://matrix-org.github.io/synapse/develop/ development/git.html ) .
435414
436415# Conclusion
437416
0 commit comments