From 768ae003394916c13c8dd93654d2a0a65ae5afe0 Mon Sep 17 00:00:00 2001 From: "Marco (Polo) Ornelas" Date: Tue, 23 Apr 2024 15:29:29 -0400 Subject: [PATCH] Add pull request template --- .github/PULL_REQUEST_TEMPLATE.md | 56 ++++++++++++++++++++++++++++++++ 1 file changed, 56 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 00000000..42643b2b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,56 @@ +# PR Checklist + +Please check if your PR fulfills the following requirements + +- [ ] The title follows our [guidelines](https://github.com/ideacrew/enroll/blob/trunk/CONTRIBUTING.md#commit) +- [ ] Tests for the changes have been added (for bugfixes/features), they use let helpers and before blocks +- [ ] For all UI changes, there is cucumber coverage +- [ ] Any endpoint touched in the PR has an appropriate Pundit policy. For open endpoints, reasoning is documented in PR and code +- [ ] For all scripts or rake tasks, how to run it is documented on both the PR and in the code +- [ ] There are no inline styles added +- [ ] There are no inline javascript added +- [ ] There is no hard coded text added/updated in helpers/views/Javascript. New/updated translation strings do not include markup/styles, unless there is supporting documentation +- [ ] Code does not use .html_safe +- [ ] All images added/updated have alt text +- [ ] Doesn’t bypass rubocop rules in any way + +# PR Type + +What kind of change does this PR introduce? + +- [ ] Bugfix +- [ ] Feature (requires Feature flag) +- [ ] Data fix or migration (inert code, no impact until run) +- [ ] Refactoring (no functional changes, no API changes) +- [ ] Build related changes +- [ ] CI related changes +- [ ] Dependency updates (e.g., add a new gem or update to a version) + +# What is the ticket # detailing the issue? + +Ticket: + +# A brief description of the changes + +Current behavior: + +New behavior: + +# Feature Flag + +For all new feature development, a feature flag is required to control the exposure of the feature to our end users. A feature flag needs a corresponding environment variable to initialize the state of the flag. Please share the name of the environment variable below that would enable/disable the feature and which client(s) it applies to. + +Variable name: + +- [ ] DC +- [ ] ME + +# Additional Context + +Include any additional context that may be relevant to the peer review process. + +# AppScan CodeSweep Failure + +In the event of a failed check on the AppScan CodeSweep step of our GitHub Actions workflow, please review the False Positive protocol outlined here: appscan_codesweep/CODESWEEP_FALSE_POSITIVES_README.MD + +Add all required notes to this section if the failure is a suspected false positive.