diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index bbca776..0f9ba9e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,38 +1,26 @@ --- -name: Bug report +name: 🐞 Bug report about: Create a report to help us improve -title: '[BUG]' -labels: 'bug' +title: '[BUG] ' +labels: bug assignees: '' - --- -**Describe the bug** -A clear and concise description of what the bug is. +### Current Behavior +<!-- A clear and concise description of what the bug is. --> + +### Expected behavior +<!-- A clear and concise description of what you expected to happen. --> -**To Reproduce** +### Steps 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] +### Screenshots +<!-- If applicable, add screenshots to help explain your problem. --> -**Additional context** -Add any other context about the problem here. +### Additional context +<!-- Add any other context about the problem here. --> \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation_needed.md b/.github/ISSUE_TEMPLATE/documentation_needed.md new file mode 100644 index 0000000..58b9cd4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_needed.md @@ -0,0 +1,31 @@ +--- +name: ✏️ Documentation needed +about: Some component needs to be documented +title: "[DOC] <title>" +labels: documentation +assignees: '' + +--- + +### What needs documentation? +<!-- Highlight with appropriate detail which component you are talking about --> + +### Current Documentation +<!-- If applicable, include links to the current documentation --> + +### Desired Documentation +<!-- Explain how you would like the documentation to be improved or what new content should be added. --> + +### Is there anything important that should be included? +<!-- Is there a particular aspect that you need clarification on? --> + +### Any suggestions where the you'd like the documentation to live? +_Choose an option from below_ +- [ ] Home README +- [ ] Localized README +- [ ] Wiki page +- [ ] Within the file +- [ ] External + +### Additional Notes +<!-- Drop any other notes here --> \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/enhancement_request.md b/.github/ISSUE_TEMPLATE/enhancement_request.md new file mode 100644 index 0000000..01bf73d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement_request.md @@ -0,0 +1,22 @@ +--- +name: ✨ Enhancement request +about: Suggest an improvement for an existing feature +title: '[ER] <title> ' +labels: enhancement +assignees: '' +--- + +### Description +<!-- Provide a clear and concise description of the enhancement you would like to request. --> + +### Current Behavior +<!-- Explain how the feature currently works. --> + +### Proposed Behavior +<!-- Describe the desired behavior or improvement you'd like to see. --> + +### Reasoning +<!-- Explain the reasons behind the enhancement request. --> + +### Suggested Implementation +<!-- [If you have specific ideas on how to implement the enhancement, provide details here. --> \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 945ed5b..25c570f 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,22 @@ --- -name: Feature request +name: 🚀 Feature request about: Suggest an idea for this project -title: '[FR]' -labels: 'enhancement' +title: '[FR] <title> ' +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 [...] +### Description +<!-- Provide a clear and concise description of the feature you would like to request. --> + +### Use Case +<!-- Explain the specific use case or problem this feature will address. --> -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +### Proposed Solution +<!-- Outline your suggested solution to the problem or how you envision the feature to work. --> -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +### Alternatives Considered +<!-- If applicable, mention any alternative solutions you've considered and explain why you believe your proposed solution is better. --> -**Additional context** -Add any other context or screenshots about the feature request here. +### Additional Context +<!-- Include any relevant additional information that could help understand the feature request better: links to related resources, examples, etc. --> \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/spike.md b/.github/ISSUE_TEMPLATE/spike.md new file mode 100644 index 0000000..f1db1d3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/spike.md @@ -0,0 +1,12 @@ +--- +name: 🔎 Spike +about: Tangential, but necessary tasks for a User Story +title: '' +labels: spike +assignees: '' +--- +This spike is related to User Story # + +### Description + +### Relation to User Story \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md new file mode 100644 index 0000000..8676eed --- /dev/null +++ b/.github/ISSUE_TEMPLATE/task.md @@ -0,0 +1,10 @@ +--- +name: ✔️ Task +about: Tasks geared toward tackling a User Story +title: '' +labels: task +assignees: '' +--- +This task is a component of User Story # + +### Description diff --git a/.github/ISSUE_TEMPLATE/user_story.md b/.github/ISSUE_TEMPLATE/user_story.md new file mode 100644 index 0000000..04c6b26 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/user_story.md @@ -0,0 +1,13 @@ +--- +name: 📖 User story +about: Software feature from the perspective of the end-user +title: As a ROLE, I want DESIRE, so that I can PROCESS +labels: user story +assignees: '' +--- + +### Description + + +### Acceptance Criteria +- [ ]