From d1e9b018198dc35696e05bd19009757d802416b4 Mon Sep 17 00:00:00 2001
From: DMRobertson Welcome to Synapse This document aims to get you started with contributing to this repo! This document aims to get you started with contributing to Synapse! Everyone is welcome to contribute code to matrix.org
projects, provided that they are willing to
@@ -230,22 +225,27 @@ pip install tox
Fix your favorite problem or perhaps find a Good First Issue
to work on. 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
-own Synapse instance, as well as developers interacting externally with 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.Contributing
-Contributing
+1. Who can contribute to Synapse?
6. Pick an issue.
7. Turn coffee and documentation into code and documentation!
-7. Turn coffee into code and documentation!
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/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.
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.
@@ -487,7 +487,7 @@ flag togit commit
, which uses the name and email set in your
By now, you know the drill!
There are some notes for those with commit access to the project on how we -manage git here.
+manage git here.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