diff options
| author | reivilibre <oliverw@matrix.org> | 2023-01-05 18:18:00 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-05 18:18:00 +0000 |
| commit | 4eb2f4e02b83c90519a8a55c562d1fafab7caf0b (patch) | |
| tree | d545643512cba7de9d64813d3b0fe0ed43e6fc54 /docs/development/contributing_guide.md | |
| parent | Bump JasonEtco/create-an-issue from 2.8.2 to 2.9.1 (#14731) (diff) | |
| download | synapse-4eb2f4e02b83c90519a8a55c562d1fafab7caf0b.tar.xz | |
Fix broken links in the Synapse documentation. (#14744)
* Fix stale external links * Fix some internal links * Fix URLs without trailing / where needed * Fix more links * Newsfile Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org> * Reapply docs/openid.md fix after conflict Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org>
Diffstat (limited to 'docs/development/contributing_guide.md')
| -rw-r--r-- | docs/development/contributing_guide.md | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md index d07790f184..43cb3e201d 100644 --- a/docs/development/contributing_guide.md +++ b/docs/development/contributing_guide.md @@ -106,8 +106,8 @@ regarding Synapse's Admin API, which is used mostly by sysadmins and external service developers. Synapse's code style is documented [here](../code_style.md). Please follow -it, including the conventions for the [sample configuration -file](../code_style.md#configuration-file-format). +it, including the conventions for [configuration +options and documentation](../code_style.md#configuration-code-and-documentation-format). We welcome improvements and additions to our documentation itself! When writing new pages, please @@ -126,7 +126,7 @@ changes to the Rust code. # 8. Test, test, test! -<a name="test-test-test"></a> +<a name="test-test-test" id="test-test-test"></a> While you're developing and before submitting a patch, you'll want to test your code. @@ -424,8 +424,7 @@ chicken-and-egg problem. There are two options for solving this: 1. Open the PR without a changelog file, see what number you got, and *then* - add the changelog file to your branch (see [Updating your pull - request](#updating-your-pull-request)), or: + add the changelog file to your branch, or: 1. Look at the [list of all issues/PRs](https://github.com/matrix-org/synapse/issues?q=), add one to the |