diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md index 6da175ae..d2f97314 100644 --- a/docs/pull_request_template.md +++ b/docs/pull_request_template.md @@ -1,31 +1,24 @@ -# Pull Request Template +🚨 PR Guidelines: -Make sure you've checked out the [contribution guideline](https://github.com/archlinux/archinstall/blob/master/CONTRIBUTING.md).
-Most of the guidelines are not enforced, but is heavily encouraged. +# New features -## Description +Merge new features in to `torxed-v2.2.0`. +This branch is designated for potential breaking changes, added complexity and new functionality. -Please include a summary of the change and which issue is fixed.
-It is also helpful to add links to online documentation or to the implementation of the code you are changing. +# Bug fixes -## Bugs and Issues +Merge against `master` for bug fixes and anything that improves stability and quality of life.
+This excludes: + * New functionality + * Added complexity + * Breaking changes -If this pull-request fixes an issue or a bug, please mention the issues with the approriate issue referece *(Example: #8)*. +# Describe your PR -## How Has This Been Tested? +If the changes has been discussed in an Issue, please tag it so we can backtrace from the Issue later on.
+If the PR is larger than ~20 lines, please describe it here unless described in an issue. -If possible, mention any tests you have made with the current code base included in the pull-requests.
-Any core-developer will also run tests, but this helps speed things up. Below is a template that can be used: +# Testing -As an example: - -**Test Configuration**: -* Hardware: VirtualBox 6.1 -* Specific steps: Ran installer with additional packages `nano` and `wget` - -## Checklist: - -- [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my own code to the best of my abilities -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation where possible/if applicable +Any new feature or stability improvement should be tested if possible. +Please follow the test instructions at the bottom of the README.