diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +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-development.md b/.github/ISSUE_TEMPLATE/feature-development.md new file mode 100644 index 0000000..7d36e9d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-development.md @@ -0,0 +1,57 @@ +--- +name: Feature Development +about: This issue is for tracking the development of a new feature or feature change +title: '' +labels: '' +assignees: '' + +--- + +# New Feature Development +Provide a short single paragraph description of the feature. + +## Assignees +Provide the names and GitHub handles of the contributors driving the implementation of this feature. + +## Background +Provide any additional background for the feature. I.e.: user scenarios, value, etc. + +## Constraints and Assumptions +Call out any constraint and/or assumption relevant for the development and use of this feature. + +## Design Changes +Provide a high-level description of the design highlighting the impacted CHP ecosystem components. +Each actionable item should be preceded by a checkbox like so: +- [ ] example + +### chp_api +Describe any changes to the chp_api repo here + +### chp +Describe any changes to the chp repo here + +#### chp_client +Describe any changes to the chp_client repo here + +#### chp_utils +Describe any changes to the chp_utils repo here + +### ChpData +Describe any changes to the ChpData repo here + +### PyBKB +Describe any changes to the PyBKB repo here + +### reasoner-validator +Describe any changes to the reasoner-validator repo here + +### trapi_model +Describe any changes to the trapi_model repo here + +## Tests +Describe here any new test requirements for this feature. This can include unit tests, integration tests, functional tests, etc. +Each actionable item should be preceded by a checkbox like so: +- [ ] example + +## References +include links to any relevant supporting documentation here diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +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. + +**Additional context** +Add any other context or screenshots about the feature request here.