From 96bbdc78ce8b0f12d52c3986c2e9087d89f2a9ef Mon Sep 17 00:00:00 2001 From: dotarjun Date: Tue, 28 Nov 2023 14:11:02 +0530 Subject: [PATCH 1/3] feat: add PR template Signed-off-by: dotarjun feat: add PR template Signed-off-by: dotarjun --- PULL_REQUEST_TEMPLATE.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..b5f48ec8 --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,22 @@ +# Description + +Fixes # (issue) + +# Type of change + +[ ] Bug fix (non-breaking change which fixes an issue) +[ ] New feature (non-breaking change which adds functionality) +[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) + +# Checklist +[ ] My code follows the style guidelines of this project +[ ] I have performed a self-review of my own code +[ ] I have commented my code, particularly in hard-to-understand areas +[ ] I have made corresponding changes to the documentation +[ ] My changes generate no new warnings +[ ] Any dependent changes have been merged and published in downstream modules + +# Screenshots (if appropriate) + +# Other information + \ No newline at end of file From 835ea87168ec862c7af838b7ccffd0a5743300ff Mon Sep 17 00:00:00 2001 From: dotarjun Date: Thu, 28 Dec 2023 19:32:53 +0530 Subject: [PATCH 2/3] update PR template Signed-off-by: dotarjun --- PULL_REQUEST_TEMPLATE.md | 43 +++++++++++++++++++++++----------------- 1 file changed, 25 insertions(+), 18 deletions(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index b5f48ec8..53cf74b9 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,22 +1,29 @@ -# Description - -Fixes # (issue) + + + -# Type of change - -[ ] Bug fix (non-breaking change which fixes an issue) -[ ] New feature (non-breaking change which adds functionality) -[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +Fixes #0000 -# Checklist -[ ] My code follows the style guidelines of this project -[ ] I have performed a self-review of my own code -[ ] I have commented my code, particularly in hard-to-understand areas -[ ] I have made corresponding changes to the documentation -[ ] My changes generate no new warnings -[ ] Any dependent changes have been merged and published in downstream modules + -# Screenshots (if appropriate) +### Tasks -# Other information - \ No newline at end of file +* [ ] Reviewed [contribution guidelines](https://github.com/nexB/scancode-toolkit/blob/develop/CONTRIBUTING.rst) +* [ ] PR is descriptively titled and links the original issue above. +* [ ] Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR + Run [tests](https://github.com/nexB/scancode-workbench?tab=readme-ov-file#testing) locally to check for errors. +* [ ] Commits are in uniquely-named feature branch and has no merge conflicts +* [ ] Looked for possible updates in documentation and added updates if applicable +* [ ] Updated CHANGELOG.rst + + + \ No newline at end of file From 57dfdda9a4248b98399e6ecfecbafab496bc981d Mon Sep 17 00:00:00 2001 From: dotarjun Date: Tue, 20 Feb 2024 11:07:28 +0530 Subject: [PATCH 3/3] typo: use the correct contributions guidelines link Signed-off-by: dotarjun --- PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 53cf74b9..7d1d58e1 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -12,7 +12,7 @@ Make sure these boxes are checked before your pull request (PR) is ready to be r ### Tasks -* [ ] Reviewed [contribution guidelines](https://github.com/nexB/scancode-toolkit/blob/develop/CONTRIBUTING.rst) +* [ ] Reviewed [contribution guidelines](https://github.com/nexB/scancode-workbench/blob/develop/CONTRIBUTING.rst) * [ ] PR is descriptively titled and links the original issue above. * [ ] Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR Run [tests](https://github.com/nexB/scancode-workbench?tab=readme-ov-file#testing) locally to check for errors.