From 47259e744d68d1a1f532134e7dc56ebc0e064901 Mon Sep 17 00:00:00 2001 From: Adam Richie-Halford Date: Thu, 30 May 2024 12:50:30 -0700 Subject: [PATCH 1/3] ENH: Add PR template --- .github/PULL_REQUEST_TEMPLATE.md | 39 ++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..07972655a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,39 @@ +## Proposed changes + +Describe your changes here. Why are they necessary? If it fixes a bug or +resolves a feature request, be sure to link to that issue. + +## Types of changes + +What types of changes does your code introduce to Appium? +_Put an `x` in the boxes that apply_ + +- [ ] Bugfix (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) +- [ ] Documentation Update (if none of the other choices apply) + +## Checklist + +_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._ + +- [ ] I have read the [guidelines for contributing](https://github.com/yeatmanlab/roar-dashboard/blob/main/.github/CONTRIBUTING.md). +- [ ] The changes in this PR are as small as they can be. They represent one and only one fix or enhancement. +- [ ] Linting checks pass with my changes. +- [ ] Any existing unit tests pass with my changes. +- [ ] Any existing end-to-end tests pass with my changes. +- [ ] I have added tests that prove my fix is effective or that my feature works. +- [ ] If this PR fixes an existing issue, I have added a unit or end-to-end test that will detect if this issue reoccurs. +- [ ] I have added JSDoc comments as appropriate. +- [ ] I have added the necessary documentation to the [roar-docs repository](https://github.com/yeatmanlab/roar-docs). + +## Justification of missing checklist items + +If you feel that a checklist item above is not applicable to this PR, please +provide your justification here. + +## Further comments + +If this is a relatively large or complex change, kick off the discussion by +explaining why you chose the solution you did and what alternatives you +considered, etc... From 74de8869e66f581183d4f0cf340904df15900d13 Mon Sep 17 00:00:00 2001 From: Adam Richie-Halford Date: Thu, 30 May 2024 12:54:14 -0700 Subject: [PATCH 2/3] Remove Appium reference --- .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 07972655a..85b7516a9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,7 +5,7 @@ resolves a feature request, be sure to link to that issue. ## Types of changes -What types of changes does your code introduce to Appium? +What types of changes does your code introduce? _Put an `x` in the boxes that apply_ - [ ] Bugfix (non-breaking change which fixes an issue) From 9208b893473bf4e3c616f2b4d7ce779154d88982 Mon Sep 17 00:00:00 2001 From: Adam Richie-Halford Date: Thu, 30 May 2024 14:06:39 -0700 Subject: [PATCH 3/3] ENH: Respond to comments --- .github/PULL_REQUEST_TEMPLATE.md | 38 ++++++++++++++++++++++++++------ 1 file changed, 31 insertions(+), 7 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 85b7516a9..2eec2be73 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,21 +1,39 @@ ## Proposed changes -Describe your changes here. Why are they necessary? If it fixes a bug or -resolves a feature request, be sure to link to that issue. + ## Types of changes -What types of changes does your code introduce? -_Put an `x` in the boxes that apply_ +What types of changes does this pull request introduce? + + - [ ] Bugfix (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) -- [ ] Documentation Update (if none of the other choices apply) +- [ ] Refactoring (non-breaking change that does not add functionality but makes code cleaner or more efficient) +- [ ] Documentation Update +- [ ] Tests (new or updated tests) +- [ ] Style (changes to code styling) +- [ ] CI (continuous integration changes) +- [ ] Repository Maintenance +- [ ] Other (please describe below) ## Checklist -_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._ + - [ ] I have read the [guidelines for contributing](https://github.com/yeatmanlab/roar-dashboard/blob/main/.github/CONTRIBUTING.md). - [ ] The changes in this PR are as small as they can be. They represent one and only one fix or enhancement. @@ -26,14 +44,20 @@ _Put an `x` in the boxes that apply. You can also fill these out after creating - [ ] If this PR fixes an existing issue, I have added a unit or end-to-end test that will detect if this issue reoccurs. - [ ] I have added JSDoc comments as appropriate. - [ ] I have added the necessary documentation to the [roar-docs repository](https://github.com/yeatmanlab/roar-docs). +- [ ] I have shared this PR on the roar-pr-reviews channel (if I have access) +- [ ] I have linked relevant issues (if any) ## Justification of missing checklist items + ## Further comments +