From fd91555f1af0becf41f6ecc7a276de6114aefc04 Mon Sep 17 00:00:00 2001 From: Azrenbeth Date: Tue, 7 Sep 2021 16:19:34 +0000 Subject: deploy: e7b78dcc4a6bf8fdb71782640932da8dff7cc5ed --- latest/development/contributing_guide.html | 80 +++++++++--------------------- 1 file changed, 23 insertions(+), 57 deletions(-) (limited to 'latest/development/contributing_guide.html') diff --git a/latest/development/contributing_guide.html b/latest/development/contributing_guide.html index 9072d49c9c..72fb4f93d1 100644 --- a/latest/development/contributing_guide.html +++ b/latest/development/contributing_guide.html @@ -99,7 +99,7 @@ @@ -182,50 +182,8 @@ - -

Contributing

-

Welcome to Synapse

-

This document aims to get you started with contributing to this repo!

- +

Contributing

+

This document aims to get you started with contributing to Synapse!

1. Who can contribute to Synapse?

Everyone is welcome to contribute code to matrix.org projects, provided that they are willing to @@ -234,7 +192,7 @@ follow a simple 'inbound=outbound' model for contributions: the act of submitting an 'inbound' contribution means that the contributor agrees to license the code under the same terms as the project's overall 'outbound' license - in our case, this is almost always Apache Software License v2 (see -LICENSE).

+LICENSE).

2. What do I need?

The code of Synapse is written in Python 3. To do pretty much anything, you'll need a recent version of Python 3.

The source code of Synapse is hosted on GitHub. You will also need a recent version of git.

@@ -267,19 +225,27 @@ pip install tox

6. Pick an issue.

Fix your favorite problem or perhaps find a Good First Issue to work on.

-

7. Turn coffee and documentation into code and documentation!

-

Synapse's code style is documented here. Please follow -it, including the conventions for the sample configuration -file.

-

There is a growing amount of documentation located in the docs -directory. This documentation is intended primarily for sysadmins running their +

7. Turn coffee into code and documentation!

+

There is a growing amount of documentation located in the +docs +directory, with a rendered version available online. +This documentation is intended primarily for sysadmins running their own Synapse instance, as well as developers interacting externally with -Synapse. docs/dev exists primarily to house documentation for -Synapse developers. docs/admin_api houses documentation +Synapse. +docs/development +exists primarily to house documentation for +Synapse developers. +docs/admin_api houses documentation regarding Synapse's Admin API, which is used mostly by sysadmins and external service developers.

-

If you add new files added to either of these folders, please use GitHub-Flavoured -Markdown.

+

Synapse's code style is documented here. Please follow +it, including the conventions for the sample configuration +file.

+

We welcome improvements and additions to our documentation itself! When +writing new pages, please +build docs to a book +to check that your contributions render correctly. The docs are written in +GitHub-Flavoured Markdown.

Some documentation also exists in Synapse's GitHub Wiki, although this is primarily contributed to by community authors.

@@ -521,7 +487,7 @@ flag to git commit, which uses the name and email set in your

By now, you know the drill!

Notes for maintainers on merging PRs etc

There are some notes for those with commit access to the project on how we -manage git here.

+manage git here.

Conclusion

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 -- cgit 1.5.1