diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..38030fe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Bug Report for Fixes/Improvements +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..b41186e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest Features +title: '' +labels: enhancement +assignees: '' + +--- + +## Issue +A clear and concise description of what the problem/feature is. + +## Solution +* Provide steps or ideals to how to implement or investigate this new feature. + +## References +* Provide additional context and external references here diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..62f8f6b --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,17 @@ +## Steps to Creating a Pull Request +* Assign yourself as the **Assignee** +* Allow one of the Code Owners/Maintainers review the changes proposed by the Pull Request. +* Provide appropriate labels as necessary + +> [!TIP] +> `enchancement` for new features, `documentation` for modifications to the docs, `performance` for performance related changes, and so on. + +* Provide a description of the work that has been done. + * It is nice to know what was added, removed, modified, and with screenshots of those changes. + +> [!TIP] +> You can have them under **Added**, **Removed**, **Updates**, and **Screenshots** if any (**Changes** could also be used). + +## After the Pull Request is Opened +* One the Pull Request has been created, please add any Issue(s) that are being addressed by this change (if any). +* If the reviewer(s) mention any changes or open threads for questions, please resolve those as soon as you can. \ No newline at end of file