From 7e9b60d25fd9154fedc9e32b5d4b8635d3b822b3 Mon Sep 17 00:00:00 2001 From: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> Date: Mon, 1 Nov 2021 13:47:55 +0100 Subject: [PATCH 1/3] Update outdated links in `PULL_REQUEST_TEMPLATE.md` --- .github/PULL_REQUEST_TEMPLATE.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index fc22d894269d..c8a5b1b3f013 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,10 +3,11 @@ * [ ] Pull request is based on the develop branch -* [ ] Pull request includes a [changelog file](https://github.com/matrix-org/synapse/blob/master/CONTRIBUTING.md#changelog). The entry should: +* [ ] Pull request includes a [changelog file](https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#changelog). The entry should: - Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from `EventStore` to `EventWorkerStore`.". - Use markdown where necessary, mostly for `code blocks`. - End with either a period (.) or an exclamation mark (!). - Start with a capital letter. -* [ ] Pull request includes a [sign off](https://github.com/matrix-org/synapse/blob/master/CONTRIBUTING.md#sign-off) -* [ ] Code style is correct (run the [linters](https://github.com/matrix-org/synapse/blob/master/CONTRIBUTING.md#code-style)) +* [ ] Pull request includes a [sign off](https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#sign-off) +* [ ] [Code style](https://matrix-org.github.io/synapse/latest/code_style.html) is correct + (run the [linters](https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#run-the-linters)) From 9f454f571e7c5c6528053c176e36400ba25ef2f1 Mon Sep 17 00:00:00 2001 From: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> Date: Mon, 1 Nov 2021 13:51:15 +0100 Subject: [PATCH 2/3] newsfile --- changelog.d/11225.misc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/11225.misc diff --git a/changelog.d/11225.misc b/changelog.d/11225.misc new file mode 100644 index 000000000000..d52a31852ec6 --- /dev/null +++ b/changelog.d/11225.misc @@ -0,0 +1 @@ +Update outdated links in contribution comments (`PULL_REQUEST_TEMPLATE.md`). From d1d3abbd8aed07f8c0926824f30e31c9ac539504 Mon Sep 17 00:00:00 2001 From: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> Date: Mon, 1 Nov 2021 17:52:02 +0100 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: David Robertson --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- changelog.d/11225.misc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c8a5b1b3f013..6c3a99849925 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@ ### Pull Request Checklist - + * [ ] Pull request is based on the develop branch * [ ] Pull request includes a [changelog file](https://matrix-org.github.io/synapse/latest/development/contributing_guide.html#changelog). The entry should: diff --git a/changelog.d/11225.misc b/changelog.d/11225.misc index d52a31852ec6..f14f65f9d4e3 100644 --- a/changelog.d/11225.misc +++ b/changelog.d/11225.misc @@ -1 +1 @@ -Update outdated links in contribution comments (`PULL_REQUEST_TEMPLATE.md`). +Replace outdated links in the pull request checklist with links to the rendered documentation.