From 60aaae4337c90bea3d485f58f7ab206cb1539a74 Mon Sep 17 00:00:00 2001 From: Anton Hvornum Date: Fri, 16 Oct 2020 11:09:23 +0200 Subject: Create pull_request_template.md --- docs/pull_request_template.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 docs/pull_request_template.md (limited to 'docs') diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md new file mode 100644 index 00000000..33c72b5f --- /dev/null +++ b/docs/pull_request_template.md @@ -0,0 +1,37 @@ +# Pull Request Template + +Make sure you've checked out the [contribution guideline](https://github.com/Torxed/archinstall/blob/master/CONTRIBUTING.md).
+Most of the guidelines are not enforced, but is heavily encouraged. + +## Description + +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. + +## Bugs and Issues + +If this pull-request fixes an issue or a bug, please mention the issues with the approriate issue referece *(Example: #8)*. + +## How Has This Been Tested? + +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: + +``` +**Test Configuration**: +* Hardware: +* Specific steps: +``` + +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 -- cgit v1.2.3-54-g00ecf