diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..1300593 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,55 @@ +name: Report a Bug +description: File a bug/issue +labels: ["Bug"] +body: + - type: textarea + attributes: + label: Current Behavior + description: A clear and concise description of what the bug is.. + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. Go to '...' + 1. Click on '...' + 1. Scroll down to '...' + 1. See error + validations: + required: true + - type: textarea + attributes: + label: Screenshots + description: | + If appropriate, please share any screenshots of the bug. + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false + - type: textarea + attributes: + label: Environment + description: | + Please share the following information, if applicable. For example: + - **OS**: Ubuntu 20.04 + - **Browser**: Firefox 133.0.3 + value: | + - OS: + - Browser: + render: markdown + validations: + required: false + - type: textarea + attributes: + label: Anything else? + description: | + Any additional context about the problem here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0086358 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..7c2a172 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,37 @@ +name: Feature Request +description: Suggest a new idea for this project +labels: ["enhancement"] +body: + - type: textarea + attributes: + label: Purpose + description: What will this feature provide? + validations: + required: true + - type: textarea + attributes: + label: Is your feature request related to a problem? Please describe. + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: false + - type: textarea + attributes: + label: Proposed Solution + description: If you have an idea on how to implement this feature, please share! + validations: + required: false + - type: textarea + attributes: + label: Acceptance Criteria + description: Please list the requirements the implementation of this feature needs to meet. + placeholder: | + - This feature should do [xyz] + - This feature should do [abc] + validations: + required: true + - type: textarea + attributes: + label: Additional Context + description: | + Add any other context or screenshots here. + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..0c7685f --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,29 @@ +## What issue is this solving? + + + +Closes #??? + +### Description + + + + + +## Any helpful knowledge/context for the reviewer? + +- Any new dependencies to install? +- Any special requirements to test? +- Any UI changes? Include screenshots if so. + +### Feelings gif (optional) + +What gif best describes your feeling working on this issue? https://giphy.com/ +How to embed: +`![alt text](https://media.giphy.com/media/1nP7ThJFes5pgXKUNf/giphy.gif)` + +### Please make sure you've attempted to meet the following coding standards + +- [ ] Code has been tested and does not produce errors +- [ ] Code is readable and formatted +- [ ] There isn't any unnecessary commented-out code