summary refs log tree commit diff
path: root/latest/development/contributing_guide.html
diff options
context:
space:
mode:
authorDMRobertson <DMRobertson@users.noreply.github.com>2023-01-17 12:46:31 +0000
committerDMRobertson <DMRobertson@users.noreply.github.com>2023-01-17 12:46:31 +0000
commit37b0c8b51348d6908a8a2e9086923ee8a24789e5 (patch)
tree4285a7f0b307a08d9c3a6fcb0eec66033aacd7c1 /latest/development/contributing_guide.html
parentdeploy: 2b084c5b710d9630178484e6ade597ca7fa814b6 (diff)
downloadsynapse-37b0c8b51348d6908a8a2e9086923ee8a24789e5.tar.xz
deploy: b6955673bfab5c8d553e8b43e9c50dd7b1212e2a
Diffstat (limited to 'latest/development/contributing_guide.html')
-rw-r--r--latest/development/contributing_guide.html11
1 files changed, 5 insertions, 6 deletions
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.</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> +it, including the conventions for <a href="../code_style.html#configuration-code-and-documentation-format">configuration +options and documentation</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> @@ -230,7 +230,7 @@ or <code>maturin develop</code> (if installed) to rebuild the Rust code. Using < is quicker than <code>poetry install</code>, so is recommended when making frequent changes to the Rust code.</p> <h1 id="8-test-test-test"><a class="header" href="#8-test-test-test">8. Test, test, test!</a></h1> -<p><a name="test-test-test"></a></p> +<p><a name="test-test-test" id="test-test-test"></a></p> <p>While you're developing and before submitting a patch, you'll want to test your code.</p> <h2 id="run-the-linters"><a class="header" href="#run-the-linters">Run the linters.</a></h2> @@ -401,7 +401,7 @@ install <a href="https://github.com/GoTestTools/gotestfmt">gotestfmt</a>.</p> </ol> <h2 id="changelog"><a class="header" href="#changelog">Changelog</a></h2> <p>All changes, even minor ones, need a corresponding changelog / newsfragment -entry. These are managed by <a href="https://github.com/hawkowl/towncrier">Towncrier</a>.</p> +entry. These are managed by <a href="https://github.com/twisted/towncrier">Towncrier</a>.</p> <p>To create a changelog entry, make a new file in the <code>changelog.d</code> directory named in the format of <code>PRnumber.type</code>. The type can be one of the following:</p> <ul> @@ -437,8 +437,7 @@ chicken-and-egg problem.</p> <ol> <li> <p>Open the PR without a changelog file, see what number you got, and <em>then</em> -add the changelog file to your branch (see <a href="#updating-your-pull-request">Updating your pull -request</a>), or:</p> +add the changelog file to your branch, or:</p> </li> <li> <p>Look at the <a href="https://github.com/matrix-org/synapse/issues?q=">list of all