From b136bc6f2d95204b5b7577628a345676618abf52 Mon Sep 17 00:00:00 2001 From: adi1090x Date: Wed, 30 Mar 2022 16:35:39 +0530 Subject: [PATCH] Added Templates for Issues and PRs --- .github/FUNDING.yml | 3 ++ .github/ISSUE_TEMPLATE.md | 50 ++++++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 45 ++++++++++++++++++++++++++++ 3 files changed, 98 insertions(+) create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..577f4f75 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,3 @@ +# These are supported funding model platforms + +ko_fi: adi1090x diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..175b8942 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,50 @@ +# Prerequisites + +Please answer the following questions for yourself before submitting an issue. +>**YOU MAY DELETE THE PREREQUISITES SECTION.** + +- [ ] I am using the [latest version](https://github.com/archcraft-os/releases/releases/tag/v21.10) +- [ ] I checked the [documentation](https://wiki.archcraft.io) and found no answer +- [ ] I checked to make sure that this issue has not already been filed +- [ ] I'm reporting the issue to the correct repository + +# Detailed Description + +Please describe the issue in detail + +# Feature request + +If this is just a feature request, please remove the rest of this template. + +# Expected Behavior + +Please describe the behavior you are expecting + +# Current Behavior + +What is the current behavior? + +# Failure Information (for bugs) + +Please help provide information about the failure if this is a bug. If it is not a bug, please remove the rest of this template. + +## Steps to Reproduce + +Please provide detailed steps for reproducing the issue. + +1. step 1 +2. step 2 +3. you get it... + +## Context + +Please provide any relevant information about your setup. This is important in case the issue is not reproducible except for under certain conditions. + +* ISO Version: +* System Specs: +* Graphics Card: +* Etc + +## Failure Logs + +Please include any relevant log snippets or files here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..2d7cc50a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,45 @@ +# Description + +Please include a summary of the change and which issue is fixed. Please provide the motivation for why this change is necessary at this stage of the product development cycle. + +Fixes # (issue) + +## Type of change + +Please delete options that are not relevant. + +- [ ] 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 not work as expected) +- [ ] This change requires a documentation update + +## User Impact + +Please describe any user facing impact of this change. This can be positive or negative impact. + +## Performance Impact + +Please describe any relevant performance impact of this change. This can be positive or negative impact. How did you characterize/test the performance impact? + +# How Has This Been Tested? + +Please describe the tests that you ran to verify your changes. Provide instructions so others can reproduce. Please also list any relevant details for your test configuration. + +- [ ] Test A +- [ ] Test B + +**Software Configuration**: +* Operating System: +* Software version: +* System Specs: +* Graphics Card: +* Etc + +# Checklist: + +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] I have added tests that prove my fix is effective or that my feature works +- [ ] New and existing unit tests pass locally with my changes