diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..432b4c9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,59 @@ +name: 🐞 Bug Report +description: File a bug/issue +title: "" +labels: + - bug + +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + + - type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: false + + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: false + + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: false + + - type: textarea + attributes: + label: Environment + description: | + Please describe your execution environment providing as much detail as possible + render: Markdown + validations: + required: false + + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..eddf02f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,42 @@ +name: 🚀 Feature Request +description: Request a new feature or enhancement +title: "<title>" +labels: + - feature + +body: + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the feature you want. + options: + - label: I have searched the existing issues + required: true + + - type: textarea + attributes: + label: How would this feature be useful? + description: Describe any use cases this solves or frustrations it alleviates. + validations: + required: false + + - type: textarea + attributes: + label: Describe the solution you'd like + description: If you have an idea on how to do this, let us know here! + validations: + required: false + + - type: textarea + attributes: + label: Describe alternatives you've considered + description: If there's some workaround or alternative solutions, let us know here! + validations: + required: false + + - type: textarea + attributes: + label: Anything else? + description: Any other relevant information or background. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index fdfcc68..6fb83c1 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -3,6 +3,7 @@ description: Ask something about the project title: "<title>" labels: - question + body: - type: checkboxes attributes: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9c75692..87a1742 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,20 +1,3 @@ -<!-- Provide a brief summary of your changes in the Title above --> +## Summary -#### Description -<!-- Describe your changes in detail --> - -#### Motivation and Context -<!-- Why is this change required? What problem does it solve? --> -<!-- If it fixes an open issue, please link to the issue here. --> -Closes # - -#### How Has This Been Tested? -<!-- Please describe in detail how you tested your changes. --> -<!-- Include details of your testing environment, tests ran to see how --> -<!-- your change affects other areas of the code, etc. --> - -#### Checklist -<!-- Go over all the following points, and put an `x` in all the boxes that apply. --> -<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> -- [ ] I have updated the documentation if needed. -- [ ] I have updated the tests if needed. +<!-- Describe your changes in detail here, if it closes an open issue, include "Closes #<issue>" --> diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml index f979e27..2d76325 100644 --- a/.github/workflows/labeler.yml +++ b/.github/workflows/labeler.yml @@ -16,7 +16,7 @@ jobs: issues: write steps: - - name: Check out the repository + - name: Checkout Code uses: actions/checkout@v4 - name: Run Labeler