From 643f9b0e5d18fdd0ef6754caac7156e8ba0eb343 Mon Sep 17 00:00:00 2001 From: Evan Palmer Date: Wed, 4 Jan 2023 12:50:01 -0800 Subject: [PATCH] Added issue and pr templates --- .github/ISSUE_TEMPLATE/bug_report.md | 42 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/ISSUE_TEMPLATE/feature_request.md | 30 ++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 35 +++++++++++++++++++ 4 files changed, 112 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..ec534b6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,42 @@ +--- +name: Bug report +about: Create a bug report +title: "[BUG]: " +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._ + +## Stack Traceback + +_If applicable, provide the stack traceback for the error. Ensure that this +trace is provided using code formatting._ + +## Project Version + +_Provide the version that the issue occurred on (e.g. 0.1.0)_ + +## Desktop + +_Please provide information regarding hardware platform that this error +occurred on (e.g., Raspberry Pi 4 running Ubuntu 22.04)_ + +## Additional context + +_Add any other context about the problem here._ diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..385215b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: alpha_driver Community Support + url: https://github.com/evan-palmer/alpha_driver/discussions + about: Please ask and answer questions here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..a0ba75d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,30 @@ +--- +name: Feature request +about: Suggest a new idea for the project +title: "[FEATURE]: " +labels: "enhancement" +assignees: "" +--- + +## Is your feature request related to a problem? Please describe + +_A clear and concise description of what the problem is. Ex. I'm always +frustrated when [...]_ + +## Describe the solution you'd like + +_A clear and concise description of what you want to happen._ + +## Describe alternatives you've considered + +_A clear and concise description of any alternative solutions or features you've +considered._ + +## Implementation Ideas + +_A description of potential implementation solutions that could be integrated to +accomplish the feature._ + +## Additional context + +_Add any other context or screenshots about the feature request here._ diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..5a772ec --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,35 @@ +# Checklist + +- [ ] I have performed a thorough review of my code +- [ ] I have sufficiently commented my code +- [ ] The implementation follows the project style conventions +- [ ] All project unit tests are passing +- [ ] If necessary, documentation has been provided or updated to discuss the changes +- [ ] System integration tests are performed successfully +- [ ] Any new dependencies have been added to the requirements list +- [ ] Any changes that will not be completed or bugs that have been introduced have been added as issues + +## Changes Made + +_A clear and concise description of all changes made in this PR. This should +include a high-level discussion regarding the implementation of the PR._ + +## Associated Issues + +_A list of all open issues that this PR will close or contribute toward closing._ + +Fixes # (issue) + +## Files Changed + +_A list of all files changed and a summary of the changes made to the respective +files._ + +## Testing + +_A clear and concise description of the testing performed. Instructions should +be included discussing how to replicate the testing results._ + +## Issues Introduced + +_A list of the issues that have been introduced through this PR._