From 37b0c8b51348d6908a8a2e9086923ee8a24789e5 Mon Sep 17 00:00:00 2001 From: DMRobertson Date: Tue, 17 Jan 2023 12:46:31 +0000 Subject: deploy: b6955673bfab5c8d553e8b43e9c50dd7b1212e2a --- latest/development/contributing_guide.html | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) (limited to 'latest/development/contributing_guide.html') diff --git a/latest/development/contributing_guide.html b/latest/development/contributing_guide.html index 1560d03e9f..e04f8d1488 100644 --- a/latest/development/contributing_guide.html +++ b/latest/development/contributing_guide.html @@ -215,8 +215,8 @@ Synapse developers. 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.

+it, including the conventions for configuration +options and documentation.

We welcome improvements and additions to our documentation itself! When writing new pages, please build docs to a book @@ -230,7 +230,7 @@ or maturin develop (if installed) to rebuild the Rust code. Using < is quicker than poetry install, so is recommended when making frequent changes to the Rust code.

8. Test, test, test!

-

+

While you're developing and before submitting a patch, you'll want to test your code.

Run the linters.

@@ -401,7 +401,7 @@ install gotestfmt.

Changelog

All changes, even minor ones, need a corresponding changelog / newsfragment -entry. These are managed by Towncrier.

+entry. These are managed by Towncrier.

To create a changelog entry, make a new file in the changelog.d directory named in the format of PRnumber.type. The type can be one of the following: