From c3d98e0b313f8a4c240cb2d8c3c7a2e3f47340a8 Mon Sep 17 00:00:00 2001 From: Savio Sou <72797635+Savio-Sou@users.noreply.github.com> Date: Thu, 18 May 2023 17:59:28 +0800 Subject: [PATCH 1/3] chore(github): Update GitHub Pull Request Template --- .github/pull_request_template.md | 60 +++++++++++++++++++++----------- 1 file changed, 40 insertions(+), 20 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2973a8bfd03..30ded860a58 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,36 +1,56 @@ -# Related issue(s) +# Description - + + -Resolves # +## Problem\* -# Description + -## Summary of changes +Resolves - +## Summary\* -## Dependency additions / changes + - +This PR sets out to -## Test additions / changes +## Example\* - + -# Checklist +Before: -- [ ] I have tested the changes locally. -- [ ] I have formatted the changes with [Prettier](https://prettier.io/) and/or `cargo fmt` with default settings. -- [ ] I have [linked](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) this PR to the issue(s) that it resolves. -- [ ] I have reviewed the changes on GitHub, line by line. -- [ ] I have ensured all changes are covered in the description. +``` + +``` + +After: + +``` + +``` + +## Documentation -## Documentation needs - [ ] This PR requires documentation updates when merged. - + -# Additional context + - [ ] I will submit a noir-lang/docs PR. - + + + - [ ] I will request for and support Dev Rel's help in documenting this PR. + + + + +## Additional Context + + + +# PR Checklist\* + +- [ ] I have tested the changes locally. +- [ ] I have formatted the changes with [Prettier](https://prettier.io/) and/or `cargo fmt` on default settings. From 4a9d5bd43b306045f2ee608158e382ecc10d8220 Mon Sep 17 00:00:00 2001 From: Globallager <72797635+Globallager@users.noreply.github.com> Date: Tue, 23 May 2023 13:04:20 +0800 Subject: [PATCH 2/3] Make Example section optional --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 30ded860a58..8d4fce098cf 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -15,7 +15,7 @@ Resolves This PR sets out to -## Example\* +### Example From 7dedfe789221ce9d21863ba859fb80e011fb4a21 Mon Sep 17 00:00:00 2001 From: Globallager <72797635+Globallager@users.noreply.github.com> Date: Tue, 23 May 2023 13:05:42 +0800 Subject: [PATCH 3/3] Revise doc comment wording --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8d4fce098cf..26c48012457 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -43,7 +43,7 @@ After: - [ ] I will request for and support Dev Rel's help in documenting this PR. - + ## Additional Context