diff options
Diffstat (limited to '.github')
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 54 |
1 files changed, 43 insertions, 11 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index cdb2e3df..1a661ea8 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,18 +1,50 @@ -<!-- -Please select the item best describing the pull request in each category and delete the other items. ---> -**Related issue**: <!-- if applicable --> +### Contributor Checklist + +- [ ] Did you add Scaladoc to every public function/method? +- [ ] Did you add at least one test demonstrating the PR? +- [ ] Did you delete any extraneous printlns/debugging code? +- [ ] Did you specify the type of improvement? +- [ ] Did you add appropriate documentation in `docs/src`? +- [ ] Did you state the API impact? +- [ ] Did you specify the code generation impact? +- [ ] Did you request a desired merge strategy? +- [ ] Did you add text to be included in the Release Notes for this change? + +#### Type of Improvement + +<!-- Choose one or more from the following: --> +<!-- - bug fix --> +<!-- - performance improvement --> +<!-- - documentation --> +<!-- - code refactoring --> +<!-- - code cleanup --> +<!-- - backend code generation --> +<!-- - new feature/API --> -<!-- choose one --> -**Type of change**: bug report | feature request | documentation | other enhancement +#### API Impact -<!-- choose one --> -**Impact**: no functional change | API addition (no impact on existing code) | API modification +<!-- How would this affect the current API? Does this add, extend, deprecate, remove, or break any existing API? --> -<!-- choose one --> -**Development Phase**: proposal | implementation +#### Backend Code Generation Impact -**Release Notes** +<!-- Does this change any generated Verilog? --> +<!-- How does it change it or in what circumstances would it? --> + +#### Desired Merge Strategy + +<!-- If approved, how should this PR be merged? --> +<!-- Options are: --> +<!-- - Squash: The PR will be squashed and merged (choose this if you have no preference. --> +<!-- - Rebase: You will rebase the PR onto master and it will be merged with a merge commit. --> + +#### Release Notes <!-- Text from here to the end of the body will be considered for inclusion in the release notes for the version containing this pull request. --> + +### Reviewer Checklist (only modified by reviewer) +- [ ] Did you add the appropriate labels? +- [ ] Did you mark the proper milestone (3.2.x, 3.3.x, 3.4.0, 3.5.0) ? +- [ ] Did you review? +- [ ] Did you check whether all relevant Contributor checkboxes have been checked? +- [ ] Did you mark as `Please Merge`? |