diff options
Diffstat (limited to 'develop/development/contributing_guide.html')
| -rw-r--r-- | develop/development/contributing_guide.html | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/develop/development/contributing_guide.html b/develop/development/contributing_guide.html index e676d7edb4..72fb4f93d1 100644 --- a/develop/development/contributing_guide.html +++ b/develop/development/contributing_guide.html @@ -182,13 +182,8 @@ <nav class="pagetoc"></nav> </div> - <!-- - Include the contents of CONTRIBUTING.md from the project root (where GitHub likes it - to be) ---> -<h1 id="contributing"><a class="header" href="#contributing">Contributing</a></h1> -<p>Welcome to Synapse</p> -<p>This document aims to get you started with contributing to this repo! </p> + <h1 id="contributing"><a class="header" href="#contributing">Contributing</a></h1> +<p>This document aims to get you started with contributing to Synapse!</p> <h1 id="1-who-can-contribute-to-synapse"><a class="header" href="#1-who-can-contribute-to-synapse">1. Who can contribute to Synapse?</a></h1> <p>Everyone is welcome to contribute code to <a href="https://github.com/matrix-org">matrix.org projects</a>, provided that they are willing to @@ -230,22 +225,27 @@ pip install tox <h1 id="6-pick-an-issue"><a class="header" href="#6-pick-an-issue">6. Pick an issue.</a></h1> <p>Fix your favorite problem or perhaps find a <a href="https://github.com/matrix-org/synapse/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+First+Issue%22">Good First Issue</a> to work on.</p> -<h1 id="7-turn-coffee-and-documentation-into-code-and-documentation"><a class="header" href="#7-turn-coffee-and-documentation-into-code-and-documentation">7. Turn coffee and documentation into code and documentation!</a></h1> -<p>Synapse's code style is documented -<a href="https://matrix-org.github.io/synapse/develop/code_style.html">here</a>. -Please follow it, including the conventions for the -<a href="https://matrix-org.github.io/synapse/develop/code_style.html#configuration-file-format">sample configuration file</a>.</p> +<h1 id="7-turn-coffee-into-code-and-documentation"><a class="header" href="#7-turn-coffee-into-code-and-documentation">7. Turn coffee into code and documentation!</a></h1> <p>There is a growing amount of documentation located in the -<a href="https://github.com/matrix-org/synapse/tree/develop/docs">docs</a> -directory. This documentation is intended primarily for sysadmins running their -own Synapse instance, as well as developers interacting externally with Synapse. -<a href="https://github.com/matrix-org/synapse/tree/develop/docs/development">docs/development</a> -exists primarily to house documentation for Synapse developers. -<a href="https://github.com/matrix-org/synapse/tree/develop/docs/admin_api">docs/admin_api</a> -houses documentation regarding Synapse's Admin API, which is used mostly by sysadmins -and external service developers.</p> -<p>If you add new files added to either of these folders, please use <a href="https://guides.github.com/features/mastering-markdown/">GitHub-Flavoured -Markdown</a>.</p> +<a href="https://github.com/matrix-org/synapse/tree/develop/docs"><code>docs</code></a> +directory, with a rendered version <a href="https://matrix-org.github.io/synapse">available online</a>. +This documentation is intended primarily for sysadmins running their +own Synapse instance, as well as developers interacting externally with +Synapse. +<a href="https://github.com/matrix-org/synapse/tree/develop/docs/development"><code>docs/development</code></a> +exists primarily to house documentation for +Synapse developers. +<a href="https://github.com/matrix-org/synapse/tree/develop/docs/admin_api"><code>docs/admin_api</code></a> houses documentation +regarding Synapse's Admin API, which is used mostly by sysadmins and external +service developers.</p> +<p>Synapse's code style is documented <a href="../code_style.html">here</a>. Please follow +it, including the conventions for the <a href="../code_style.html#configuration-file-format">sample configuration +file</a>.</p> +<p>We welcome improvements and additions to our documentation itself! When +writing new pages, please +<a href="https://github.com/matrix-org/synapse/tree/develop/docs#adding-to-the-documentation">build <code>docs</code> to a book</a> +to check that your contributions render correctly. The docs are written in +<a href="https://guides.github.com/features/mastering-markdown/">GitHub-Flavoured Markdown</a>.</p> <p>Some documentation also exists in <a href="https://github.com/matrix-org/synapse/wiki">Synapse's GitHub Wiki</a>, although this is primarily contributed to by community authors.</p> @@ -487,7 +487,7 @@ flag to <code>git commit</code>, which uses the name and email set in your <p>By now, you know the drill!</p> <h1 id="notes-for-maintainers-on-merging-prs-etc"><a class="header" href="#notes-for-maintainers-on-merging-prs-etc">Notes for maintainers on merging PRs etc</a></h1> <p>There are some notes for those with commit access to the project on how we -manage git <a href="https://matrix-org.github.io/synapse/develop/development/git.html">here</a>.</p> +manage git <a href="git.html">here</a>.</p> <h1 id="conclusion"><a class="header" href="#conclusion">Conclusion</a></h1> <p>That's it! Matrix is a very open and collaborative project as you might expect given our obsession with open communication. If we're going to successfully |