diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md new file mode 100644 index 00000000..b5a536b4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +### Bug Description + +A clear and concise description of what the bug is. + +In the format "When I do X, I expect Y but observe Z" + +### 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. + +## SIPNET Version + + - Version or Git SHA [e.g. 2.1.0 or abc1234] + +## Additional context + +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/Doc_changes.md b/.github/ISSUE_TEMPLATE/Doc_changes.md new file mode 100644 index 00000000..d285a37f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Doc_changes.md @@ -0,0 +1,18 @@ +--- +name: Documentation Changes +about: Create a report to help us improve + +--- + +### Document Change needed + +A clear description of what changes are needed with the location of the error, or that needs to be fixed. + +Example: +There is a broken URL link in the documentation. It is in the parameters documentation. The underlying file is `docs/parameters.md`. The correct link should be https://aws.amazon.com/. + +### Information for those wanting to make changes + +Please refer to the documentation guidelines in `CONTRIBUTING.md` to learn how to make changes to the documentation. + +All markdown files related to documentation are located within the main directory `docs/`. diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md new file mode 100644 index 00000000..68eaf666 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -0,0 +1,24 @@ +--- +name: Feature request +about: Suggest an idea for this project + +--- + +## Description + +**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 [...] + +## Use Cases and Requirements + +**Describe the use cases and requirements** +Please focus on describing the problem and your requirements without going into the solution space. We believe in understanding requirements before design, and design before solution! + +## Alternatives Considered (Optional) + +**Describe alternatives you've considered** +A clear and concise description of any alternative workflows or workarounds you are currently using. + +## Additional Context + +Add any other context or screenshots about the feature request here.