From d77fd5c320cdff54aa67e8633d3ec4689fe9b384 Mon Sep 17 00:00:00 2001 From: Esha Noronha Date: Fri, 23 May 2025 10:42:24 +0200 Subject: [PATCH 1/4] New PR template --- .github/pull_request_template.md | 35 +++++++++++++++++++++++--------- 1 file changed, 25 insertions(+), 10 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 08f857a4f79..fc6c2289990 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,19 +1,34 @@ -## Description +## ๐Ÿ“‹ Description -_What did you add/update/change?_ + -## Type of suggestion +## ๐Ÿ“Ž Related Issues (if applicable) -* [ ] Typo/grammar fix -* [ ] Updated outdated content -* [ ] New content -* [ ] Updates related to a new version -* [ ] Other + -## Product & version (if relevant) +## โœ… Contributor Checklist +Please confirm the following before submitting your PR: +* [ ] My changes follow the [Umbraco Docs Style Guide](https://docs.umbraco.com/contributing/documentation/style-guide). +* [ ] Code blocks are formatted correctly. +* [ ] Sentences are short and clear (preferably under 25 words). +* [ ] Avoided passive voice and first-person language (โ€œweโ€, โ€œIโ€). +* [ ] Relevant pages are linked. +* [ ] All links work and point to the correct resources. +* [ ] Screenshots or diagrams are included (if useful). +* [ ] Iโ€™ve tested any code examples or instructions where relevant. +* [ ] Fixed typo/broken links/broken images + +## Product & Version (if relevant) + + ## Deadline (if relevant) -_When should the content be published?_ + + +## ๐Ÿ“š Helpful Resources + +* ๐Ÿงพ [Umbraco Contribution Guidelines](https://docs.umbraco.com/contributing) +* โœ๏ธ [Umbraco Docs Style Guide](https://docs.umbraco.com/contributing/documentation/style-guide) From b2baf907a6737c28ded85757722c627ccbba99f8 Mon Sep 17 00:00:00 2001 From: Esha Noronha Date: Fri, 23 May 2025 10:49:22 +0200 Subject: [PATCH 2/4] Fixed vale warning --- .github/pull_request_template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index fc6c2289990..9f08a449f28 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,7 +10,7 @@ Please confirm the following before submitting your PR: -* [ ] My changes follow the [Umbraco Docs Style Guide](https://docs.umbraco.com/contributing/documentation/style-guide). +* [ ] My changes follow the [Umbraco Documentation Style Guide](https://docs.umbraco.com/contributing/documentation/style-guide). * [ ] Code blocks are formatted correctly. * [ ] Sentences are short and clear (preferably under 25 words). * [ ] Avoided passive voice and first-person language (โ€œweโ€, โ€œIโ€). @@ -31,4 +31,4 @@ Please confirm the following before submitting your PR: ## ๐Ÿ“š Helpful Resources * ๐Ÿงพ [Umbraco Contribution Guidelines](https://docs.umbraco.com/contributing) -* โœ๏ธ [Umbraco Docs Style Guide](https://docs.umbraco.com/contributing/documentation/style-guide) +* โœ๏ธ [Umbraco Documentation Style Guide](https://docs.umbraco.com/contributing/documentation/style-guide) From 053b9361dbc7a34ff20a711fa924ff609da0b369 Mon Sep 17 00:00:00 2001 From: Esha Noronha Date: Mon, 26 May 2025 09:54:16 +0200 Subject: [PATCH 3/4] Incorporated review comments --- .github/pull_request_template.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9f08a449f28..89ed677bc02 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -8,17 +8,17 @@ ## โœ… Contributor Checklist -Please confirm the following before submitting your PR: +I've followed the guidelines and can confirm that: -* [ ] My changes follow the [Umbraco Documentation Style Guide](https://docs.umbraco.com/contributing/documentation/style-guide). -* [ ] Code blocks are formatted correctly. +* [ ] The changes follow the [Umbraco Documentation Style Guide](https://docs.umbraco.com/contributing/documentation/style-guide). +* [ ] Code blocks are correctly formatted. * [ ] Sentences are short and clear (preferably under 25 words). -* [ ] Avoided passive voice and first-person language (โ€œweโ€, โ€œIโ€). +* [ ] Passive voice and first-person language (โ€œweโ€, โ€œIโ€) are avoided. * [ ] Relevant pages are linked. * [ ] All links work and point to the correct resources. -* [ ] Screenshots or diagrams are included (if useful). -* [ ] Iโ€™ve tested any code examples or instructions where relevant. -* [ ] Fixed typo/broken links/broken images +* [ ] Screenshots or diagrams are included if useful. +* [ ] Any code examples or instructions have been tested. +* [ ] Typos, broken links, and broken images are fixed. ## Product & Version (if relevant) From 313f7267231d32b5cd9caedd33613e7412f05cbb Mon Sep 17 00:00:00 2001 From: Esha Noronha <82437098+eshanrnh@users.noreply.github.com> Date: Tue, 27 May 2025 09:27:27 +0200 Subject: [PATCH 4/4] Update .github/pull_request_template.md Co-authored-by: sofietoft --- .github/pull_request_template.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 89ed677bc02..b26893ac133 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -8,9 +8,8 @@ ## โœ… Contributor Checklist -I've followed the guidelines and can confirm that: +I've followed the [Umbraco Documentation Style Guide](https://docs.umbraco.com/contributing/documentation/style-guide) and can confirm that: -* [ ] The changes follow the [Umbraco Documentation Style Guide](https://docs.umbraco.com/contributing/documentation/style-guide). * [ ] Code blocks are correctly formatted. * [ ] Sentences are short and clear (preferably under 25 words). * [ ] Passive voice and first-person language (โ€œweโ€, โ€œIโ€) are avoided.