Merge pull request #6 from Seshat-Global-History-Databank/kallewester…

…ling/issue2

Create issue templates

.github/ISSUE_TEMPLATE/BUG_REPORT.yml

@@ -0,0 +1,80 @@
+name: "🐛 Bug Report"
+description: Create a new ticket for a bug.
+title: "🐛 [BUG] - <title>"
+labels: [
+  "bug"
+]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: "Description"
+      description: Please enter an explicit description of your issue
+      placeholder: Short and explicit description of your incident...
+    validations:
+      required: true
+  # - type: input
+  #   id: reprod-url
+  #   attributes:
+  #     label: "Reproduction URL"
+  #     description: Please enter your GitHub URL to provide a reproduction of the issue
+  #     placeholder: ex. https://github.com/USERNAME/REPO-NAME
+  #   validations:
+  #     required: true
+  - type: textarea
+    id: reprod
+    attributes:
+      label: "Reproduction steps"
+      description: Please enter an explicit description of your issue
+      value: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+      render: bash
+    validations:
+      required: true
+  - type: textarea
+    id: screenshot
+    attributes:
+      label: "Screenshots"
+      description: If applicable, add screenshots to help explain your problem.
+      value: |
+        ![DESCRIPTION](LINK.png)
+      render: bash
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: "Logs"
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: bash
+    validations:
+      required: false
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: "Browsers"
+      description: What browsers are you seeing the problem on ?
+      multiple: true
+      options:
+        - Firefox
+        - Chrome
+        - Safari
+        - Microsoft Edge
+        - Opera
+    validations:
+      required: false
+  - type: dropdown
+    id: os
+    attributes:
+      label: "OS"
+      description: What is the impacted environment ?
+      multiple: true
+      options:
+        - Windows
+        - Linux
+        - Mac
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/DOCS_IMPROVEMENT.yml

@@ -0,0 +1,53 @@
+name: Documentation Improvement
+
+description: Suggest changes or improvements to the documentation.
+
+title: "📚 [Documentation] <title>"
+
+labels: ["documentation"]
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ## Documentation Improvement Request
+
+        Thank you for taking the time to help improve our documentation! Please provide the details of your suggestion below.
+
+        ### Example
+
+        **Section of Documentation**: Installation Instructions
+
+        **Description of Improvement**: Add a troubleshooting guide for common installation issues on Windows.
+
+        **Benefits of Improvement**: Helps users resolve installation problems quickly, reducing frustration and support requests.
+
+        **Additional Context**: Based on frequent questions from users in the community forums.
+
+  - type: input
+    id: section
+    attributes:
+      label: Section of Documentation
+      description: Which section of the documentation does this improvement pertain to?
+      placeholder: "e.g., Installation Instructions, User Guide, API Reference"
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description of Improvement
+      description: Provide a detailed description of the improvement you are suggesting.
+      placeholder: "Describe the change or addition you would like to see."
+
+  - type: input
+    id: benefits
+    attributes:
+      label: Benefits of Improvement
+      description: Explain how this improvement will benefit users.
+      placeholder: "e.g., clearer instructions, easier navigation, more comprehensive coverage"
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: Add any other context or information related to this improvement request.
+      placeholder: "Include any relevant links, examples, or references."

.github/ISSUE_TEMPLATE/USER_STORY.yml

@@ -0,0 +1,97 @@
+name: Feature request
+description: To create a new feature request, we ask that you write a user story.
+title: "👤 [User Story]: "
+labels: ["feature-request"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for contributing an idea for a new feature! Please fill out the user story details below to help us understand your vision for the new feature.
+
+  - type: input
+    id: role
+    attributes:
+      label: Role
+      description: Who is the user for this story?
+      placeholder: ex. As a [Admin]
+    validations:
+      required: true
+
+  - type: input
+    id: feature
+    attributes:
+      label: Desired Feature
+      description: What is the feature you would like to have?
+      placeholder: I want to [feature description]
+    validations:
+      required: true
+
+  - type: input
+    id: benefit
+    attributes:
+      label: Benefit
+      description: What is the benefit of this feature?
+      placeholder: So that I can [benefit description]
+    validations:
+      required: true
+
+  - type: textarea
+    id: acceptance-criteria
+    attributes:
+      label: Acceptance Criteria
+      description:
+        Please describe the conditions that must be met for this story to be
+        considered complete.
+      placeholder: |
+        **GIVEN** [precondition]
+        **AND** [another precondition if necessary]
+        **WHEN** [action taken by the user]
+        **THEN** [expected outcome]
+        **AND** [another outcome if necessary]
+    validations:
+      required: true
+
+  - type: textarea
+    id: dependencies
+    attributes:
+      label: Dependencies
+      description: Are there any other tasks that need to be completed first?
+      placeholder: |
+        - [ ] Dependency 1 (include issue link)
+        - [ ] Dependency 2 (include issue link)
+    validations:
+      required: false
+
+  - type: textarea
+    id: technical-notes
+    attributes:
+      label: Technical Notes
+      description:
+        Any technical notes, potential challenges, or architectural
+        considerations for implementation?
+      placeholder: |
+        - Note 1
+        - Note 2
+    validations:
+      required: false
+
+  - type: checkboxes
+    id: definition-of-done
+    attributes:
+      label: Definition of Done
+      description:
+        Please confirm the following are completed before this story can be
+        considered done.
+      options:
+        - label: The feature fulfills all acceptance criteria.
+        - label: The code is reviewed and meets team coding standards.
+        - label: All unit, integration, and end-to-end tests are passed.
+        - label: The feature meets accessibility standards set for the project.
+        - label:
+            The code passes the CI/CD pipeline quality controls (style and
+            linting).
+        - label: The feature is merged into the main branch.
+        - label: The feature is deployed and functional in the QA environment.
+        - label:
+            The feature was demonstrated to the team and accepted by the product
+            owner.