Update PR template

MarkUsProject · Apr 30, 2024 · 62c3cc4 · 62c3cc4
1 parent 9673173
commit 62c3cc4
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 38 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,50 +1,53 @@
-<!--- Provide a summary of your changes in the Pull Request Title above. -->
-<!--- If this is a work in progress (not yet ready to be merged), make this a draft pull request. -->
+## Proposed Changes
+*(Describe your changes here. Also describe the motivation for your changes: what problem do they solve, or how do they improve the application or codebase? If this pull request fixes an open issue, [use a keyword to link this pull request to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).)*
 
-## Motivation and Context
-<!--- Why is this pull request required? What problem does it solve? -->
-<!--- If it fixes an open issue, please link to the issue here. -->
+...
 
+<details>
+<summary>Screenshots of your changes (if applicable)</summary>
 
-## Your Changes
-<!--- Describe your changes here. -->
-<!--- Include how your changes may affect other areas of the application, if relevant. -->
-**Description**:
+</details>
 
+<details>
+<summary>Associated [documentation repository](https://github.com/MarkUsProject/Wiki) pull request (if applicable)</summary>
 
-**Type of change** (select all that apply):
-<!--- Put an `x` in all the boxes that apply. -->
-<!--- Remove any lines that do not apply. -->
+</details>
 
-- [ ] 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 change)
-- [ ] Refactoring (internal change to codebase, without changing functionality)
-- [ ] Test update (change that modifies or updates tests only)
-- [ ] Other (please specify):
+## Type of Change
+*(Write an `X` or a brief description next to the type or types that best describe your changes.)*
 
+| Type                                                                                    | Applies? |
+|-----------------------------------------------------------------------------------------|----------|
+| 🚨 *Breaking change* (fix or feature that would cause existing functionality to change) |          |
+| ✨ *New feature* (non-breaking change that adds functionality)                          |          |
+| 🐛 *Bug fix* (non-breaking change that fixes an issue)                                  |          |
+| ♻️ *Refactoring* (internal change to codebase, without changing functionality)          |          |
+| 🚦 *Test update* (change that *only* adds or modifies tests)                            |          |
+| 📦 *Dependency update* (change that updates a dependency)                               |          |
+| 🔧 *Internal* (change that *only* affects developers or continuous integration)         |          |
 
-## Testing
-<!--- Please describe in detail how you tested this pull request. -->
-<!--- This can include tests you added and manual testing through the web interface. -->
 
+## Checklist
+*(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the `[ ]` into a `[x]` in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)*
 
-## Questions and Comments (if applicable)
-<!-- Ask any questions you have for the maintainers of this project regarding this PR. -->
-<!-- Please describe the steps you have already taken to find the answer to your question. -->
-<!-- This will ensure that we can give you clear and relevant advice. -->
-<!-- If you have additional comments add them here as well. -->
+Before opening your pull request:
 
+- [ ] I have performed a self-review of my changes.
+  - Check that all changed files included in this pull request are intentional changes.
+  - Check that all changes are relevant to the purpose of this pull request, as described above.
+- [ ] I have added tests for my changes, if applicable.
+  - This is **required** for all bug fixes and new features.
+- [ ] I have updated the project documentation, if applicable.
+  - This is **required** for new features.
+- [ ] If this is my first contribution, I have added myself to the list of contributors.
 
-## Checklist
+After opening your pull request:
 
-- [ ] I have performed a self-review of my own code.
-- [ ] I have verified that the pre-commit.ci checks have passed. <!-- (check after opening pull request) -->
-- [ ] I have verified that the CI tests have passed. <!-- (check after opening pull request) -->
-- [ ] I have reviewed the test coverage changes reported on Coveralls. <!-- (check after opening pull request) -->
-- [ ] I have added tests for my changes. <!-- (delete this checklist item if not applicable) -->
-- [ ] I have updated the Changelog.md file. <!-- (delete this checklist item if not applicable) -->
-- [ ] I have made changes to the documentation and linked to that pull request below. <!-- (delete this checklist item if not applicable) -->
+- [ ] I have updated the project Changelog (this is required for all changes).
+- [ ] I have verified that the pre-commit.ci checks have passed.
+- [ ] I have verified that the CI tests have passed.
+- [ ] I have reviewed the test coverage changes reported by Coveralls.
+- [ ] I have [requested a review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review) from a project maintainer.
 
-### Pull request to make documentation changes (if applicable)
-<!--- Add a link to a pull request on the MarkUsProject/Wiki repo -->
+## Questions and Comments
+*(Include any questions or comments you have regarding your changes.)*
diff --git a/Changelog.md b/Changelog.md
@@ -1,17 +1,27 @@
 # Changelog
 
 ## [unreleased]
+
+### 🚨 Breaking changes
+
+### ✨ New features and improvements
+
 - Allow deletion of assignments with no groups (#6880)
 - Add new routes for `update`, `show`, and `index` actions of the Sections API Controller (#6955)
 - Enable the deletion of Grade Entry Forms that have no grades (#6915)
-- Fixed login_spec.rb flaky test on GitHub Actions run (#6966)
-- Minor improvements in assignment association options (#6989)
 - Allow instructors to configure an end date until which students can run automated tests (#6992)
 - Gave TAs read-only access to starter file information under assignment settings (#6996)
 - Allow inactive groups in the submissions table to be toggled for display (#7000)
 - Display error message for student-run tests when no test groups are runnable (#7003)
 - Added a confirmation check while renaming a file with a different extension (#7024)
 
+### 🐛 Bug fixes
+
+### 🔧 Internal changes
+
+- Fixed login_spec.rb flaky test on GitHub Actions run (#6966)
+- Minor improvements in assignment association options (#6989)
+
 ## [v2.4.9]
 - Peer review table bug fix to display total marks (#7034)
 - Fix bug preventing deletion of autotest files (#7033)