From 18001098795da64344ff1f39e300deae65686e27 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zolt=C3=A1n=20Leh=C3=B3czky?= Date: Wed, 25 Sep 2024 17:46:30 +0200 Subject: [PATCH] Sample for PR to issue linking --- src/docs/guides/contributing/contributing-code.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/guides/contributing/contributing-code.md b/src/docs/guides/contributing/contributing-code.md index 4c640fe864f..da4ec95d5eb 100644 --- a/src/docs/guides/contributing/contributing-code.md +++ b/src/docs/guides/contributing/contributing-code.md @@ -46,7 +46,7 @@ You might also read these two blog posts on contributing code: [Open Source Cont - Make sure the repository can be built and all tests pass. This is also checked by the CI workflows. - If you change CSS or JavaScript files, be sure to run [the Gulp pipeline](../../guides/gulp-pipeline/README.md). - If you want to start a conversation with other community members or run the CI workflows but you're not done yet, open your PR as a [draft](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests#draft-pull-requests). Then, [change it to ready for review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request). -- If your PR addresses an issue, be sure to [link them](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). This helps everyone find their way around contributions, and merging your PR will automatically close the issue too. +- If your PR addresses an issue, be sure to [link them](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) (e.g. with `Fixes #IssueId`). This helps everyone find their way around contributions, and merging your PR will automatically close the issue too. - If there's no issue for your PR, then please describe the context and rationale in the pull request description, and provide screenshots/screen recordings of the changes if they affect the UX. - Refactoring is great, but if you do so, please guard it with new tests. - If you add a significant new feature or a breaking change, then document this under the release notes of the upcoming release (you can find this in the `docs/OrchardCore.Docs/releases` folder).