From 02b13df85a4b1de61b06bdacc2e01a7f22408de8 Mon Sep 17 00:00:00 2001 From: ZachWatkins <3458875+ZachWatkins@users.noreply.github.com> Date: Fri, 16 May 2025 19:56:48 -0500 Subject: [PATCH] Rename issue template directory to avoid activating them on all of my repositories --- .../bug-report.yml | 78 ++++++++-------- .../config.yml | 16 ++-- .../feature-request.yml | 72 +++++++-------- .../improve-documentation.yml | 86 +++++++++--------- .../maintenance.yml | 90 +++++++++---------- 5 files changed, 171 insertions(+), 171 deletions(-) rename .github/{ISSUE_TEMPLATE => ISSUE_TEMPLATE_EXAMPLES}/bug-report.yml (97%) rename .github/{ISSUE_TEMPLATE => ISSUE_TEMPLATE_EXAMPLES}/config.yml (97%) rename .github/{ISSUE_TEMPLATE => ISSUE_TEMPLATE_EXAMPLES}/feature-request.yml (97%) rename .github/{ISSUE_TEMPLATE => ISSUE_TEMPLATE_EXAMPLES}/improve-documentation.yml (97%) rename .github/{ISSUE_TEMPLATE => ISSUE_TEMPLATE_EXAMPLES}/maintenance.yml (97%) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE_EXAMPLES/bug-report.yml similarity index 97% rename from .github/ISSUE_TEMPLATE/bug-report.yml rename to .github/ISSUE_TEMPLATE_EXAMPLES/bug-report.yml index e6c0fc0..3038620 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE_EXAMPLES/bug-report.yml @@ -1,39 +1,39 @@ -name: Bug Report -description: "Report something that's broken." -body: - - type: markdown - attributes: - value: | - * For questions, ask in [Discussions](https://github.com/zachwatkins/.github/discussions). - * Check to make sure someone hasn't already opened a similar bug report [issue](https://github.com/zachwatkins/.github/issues). - - - type: checkboxes - id: terms - attributes: - label: Code of Conduct - description: This project has a Code of Conduct that all participants are expected to understand and follow. - options: - - label: I have read and agree to the project's [Code of Conduct](https://github.com/zachwatkins/.github/blob/main/CODE_OF_CONDUCT.md) - required: true - - - type: input - attributes: - label: Version Number - description: Provide the version number that you are using. - placeholder: 1.0.0 - validations: - required: true - - - type: textarea - attributes: - label: Description - description: Provide a detailed description of the issue you are facing. - validations: - required: true - - - type: textarea - attributes: - label: Steps To Reproduce - description: Provide detailed steps to reproduce your issue. If necessary, please provide a GitHub repository to demonstrate your issue. - validations: - required: true +name: Bug Report +description: "Report something that's broken." +body: + - type: markdown + attributes: + value: | + * For questions, ask in [Discussions](https://github.com/zachwatkins/.github/discussions). + * Check to make sure someone hasn't already opened a similar bug report [issue](https://github.com/zachwatkins/.github/issues). + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: This project has a Code of Conduct that all participants are expected to understand and follow. + options: + - label: I have read and agree to the project's [Code of Conduct](https://github.com/zachwatkins/.github/blob/main/CODE_OF_CONDUCT.md) + required: true + + - type: input + attributes: + label: Version Number + description: Provide the version number that you are using. + placeholder: 1.0.0 + validations: + required: true + + - type: textarea + attributes: + label: Description + description: Provide a detailed description of the issue you are facing. + validations: + required: true + + - type: textarea + attributes: + label: Steps To Reproduce + description: Provide detailed steps to reproduce your issue. If necessary, please provide a GitHub repository to demonstrate your issue. + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE_EXAMPLES/config.yml similarity index 97% rename from .github/ISSUE_TEMPLATE/config.yml rename to .github/ISSUE_TEMPLATE_EXAMPLES/config.yml index 462aae9..4c3a20c 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE_EXAMPLES/config.yml @@ -1,8 +1,8 @@ -blank_issues_enabled: false -contact_links: - - name: Feature request - url: https://github.com/zachwatkins/.github/discussions - about: 'For ideas or feature requests, start a new discussion first.' - - name: Inquiries - url: https://zachwatkins.dev/contact - about: Contact me if you have any questions about my work. +blank_issues_enabled: false +contact_links: + - name: Feature request + url: https://github.com/zachwatkins/.github/discussions + about: 'For ideas or feature requests, start a new discussion first.' + - name: Inquiries + url: https://zachwatkins.dev/contact + about: Contact me if you have any questions about my work. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE_EXAMPLES/feature-request.yml similarity index 97% rename from .github/ISSUE_TEMPLATE/feature-request.yml rename to .github/ISSUE_TEMPLATE_EXAMPLES/feature-request.yml index 3b033c8..b2a3df9 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE_EXAMPLES/feature-request.yml @@ -1,36 +1,36 @@ -name: Request a feature -description: Suggest a new feature for the project. -labels: - - feature -body: - - type: markdown - attributes: - value: | - * For questions, ask in [Discussions](https://github.com/zachwatkins/.github/discussions). - * Check to make sure someone hasn't already opened a similar feature request [issue](https://github.com/zachwatkins/.github/issues). - - - type: checkboxes - id: terms - attributes: - label: Code of Conduct - description: This project has a Code of Conduct that all participants are expected to understand and follow. - options: - - label: I have read and agree to the project's [Code of Conduct](https://github.com/zachwatkins/.github/blob/main/CODE_OF_CONDUCT.md) - required: true - - - type: textarea - attributes: - label: What part of the project is involved? - description: Include links, screenshots, what browser you're using, etc. - validations: - required: true - - - type: textarea - attributes: - label: What changes are you suggesting? - description: | - - Give as much detail as you can to help us understand the change you want to see. - - Why should the project be changed? What use cases does it support? - - What is the expected outcome? - validations: - required: true +name: Request a feature +description: Suggest a new feature for the project. +labels: + - feature +body: + - type: markdown + attributes: + value: | + * For questions, ask in [Discussions](https://github.com/zachwatkins/.github/discussions). + * Check to make sure someone hasn't already opened a similar feature request [issue](https://github.com/zachwatkins/.github/issues). + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: This project has a Code of Conduct that all participants are expected to understand and follow. + options: + - label: I have read and agree to the project's [Code of Conduct](https://github.com/zachwatkins/.github/blob/main/CODE_OF_CONDUCT.md) + required: true + + - type: textarea + attributes: + label: What part of the project is involved? + description: Include links, screenshots, what browser you're using, etc. + validations: + required: true + + - type: textarea + attributes: + label: What changes are you suggesting? + description: | + - Give as much detail as you can to help us understand the change you want to see. + - Why should the project be changed? What use cases does it support? + - What is the expected outcome? + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/improve-documentation.yml b/.github/ISSUE_TEMPLATE_EXAMPLES/improve-documentation.yml similarity index 97% rename from .github/ISSUE_TEMPLATE/improve-documentation.yml rename to .github/ISSUE_TEMPLATE_EXAMPLES/improve-documentation.yml index 190c940..3fc0137 100644 --- a/.github/ISSUE_TEMPLATE/improve-documentation.yml +++ b/.github/ISSUE_TEMPLATE_EXAMPLES/improve-documentation.yml @@ -1,43 +1,43 @@ -name: Improve documentation -description: Make a suggestion to improve the documentation for a package. -labels: - - documentation -body: - - type: markdown - attributes: - value: | - * For questions, ask in [Discussions](https://github.com/zachwatkins/.github/discussions). - * Before you file an issue, check to make sure someone hasn't already opened a similar [issue](https://github.com/zachwatkins/.github/issues). - - - type: checkboxes - id: terms - attributes: - label: Code of Conduct - description: This project has a Code of Conduct that all participants are expected to understand and follow. - options: - - label: I have read and agree to the project's [Code of Conduct](https://github.com/zachwatkins/.github/blob/main/CODE_OF_CONDUCT.md) - required: true - - - type: textarea - attributes: - label: What article is affected? - description: Please link to the article you'd like to see updated. - validations: - required: true - - - type: textarea - attributes: - label: What part(s) of the article would you like to see updated? - description: | - - Give as much detail as you can to help us understand the change you want to see. - - Why should the article be changed? What use cases does it support? - - What is the expected outcome? - validations: - required: true - - - type: textarea - attributes: - label: Additional information - description: Add any other context or screenshots about the feature request here. - validations: - required: false +name: Improve documentation +description: Make a suggestion to improve the documentation for a package. +labels: + - documentation +body: + - type: markdown + attributes: + value: | + * For questions, ask in [Discussions](https://github.com/zachwatkins/.github/discussions). + * Before you file an issue, check to make sure someone hasn't already opened a similar [issue](https://github.com/zachwatkins/.github/issues). + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: This project has a Code of Conduct that all participants are expected to understand and follow. + options: + - label: I have read and agree to the project's [Code of Conduct](https://github.com/zachwatkins/.github/blob/main/CODE_OF_CONDUCT.md) + required: true + + - type: textarea + attributes: + label: What article is affected? + description: Please link to the article you'd like to see updated. + validations: + required: true + + - type: textarea + attributes: + label: What part(s) of the article would you like to see updated? + description: | + - Give as much detail as you can to help us understand the change you want to see. + - Why should the article be changed? What use cases does it support? + - What is the expected outcome? + validations: + required: true + + - type: textarea + attributes: + label: Additional information + description: Add any other context or screenshots about the feature request here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/maintenance.yml b/.github/ISSUE_TEMPLATE_EXAMPLES/maintenance.yml similarity index 97% rename from .github/ISSUE_TEMPLATE/maintenance.yml rename to .github/ISSUE_TEMPLATE_EXAMPLES/maintenance.yml index 8d9c055..e42d3fa 100644 --- a/.github/ISSUE_TEMPLATE/maintenance.yml +++ b/.github/ISSUE_TEMPLATE_EXAMPLES/maintenance.yml @@ -1,45 +1,45 @@ -name: Request maintenance -description: Submit a request for maintenance of the project's dependencies, development tools, or source code. -labels: - - maintenance -body: - - type: markdown - attributes: - value: | - * Check to make sure someone hasn't already opened a similar maintenance request [issue](https://github.com/zachwatkins/.github/issues). - - - type: checkboxes - id: terms - attributes: - label: Code of Conduct - description: This project has a Code of Conduct that all participants are expected to understand and follow. - options: - - label: I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/zachwatkins/.github/blob/main/CODE_OF_CONDUCT.md) - required: true - - - type: textarea - attributes: - label: What part of the project is involved? - description: Include links, screenshots, what browser you're using, etc. - validations: - required: true - - - type: textarea - attributes: - label: What changes are you suggesting? - description: | - - Give as much detail as you can to help us understand the change you want to see. - - Why should the project be changed? What use cases does it support? - - What is the expected outcome? - validations: - required: true - - - type: checkboxes - attributes: - label: Pull Request - description: When submitting a pull request, please be sure to complete each of the following. - options: - - label: MUST reference this issue, e.g. via `closes [this issue number]`. - required: true - - label: MUST pass the automated CI checks. - required: true +name: Request maintenance +description: Submit a request for maintenance of the project's dependencies, development tools, or source code. +labels: + - maintenance +body: + - type: markdown + attributes: + value: | + * Check to make sure someone hasn't already opened a similar maintenance request [issue](https://github.com/zachwatkins/.github/issues). + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: This project has a Code of Conduct that all participants are expected to understand and follow. + options: + - label: I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/zachwatkins/.github/blob/main/CODE_OF_CONDUCT.md) + required: true + + - type: textarea + attributes: + label: What part of the project is involved? + description: Include links, screenshots, what browser you're using, etc. + validations: + required: true + + - type: textarea + attributes: + label: What changes are you suggesting? + description: | + - Give as much detail as you can to help us understand the change you want to see. + - Why should the project be changed? What use cases does it support? + - What is the expected outcome? + validations: + required: true + + - type: checkboxes + attributes: + label: Pull Request + description: When submitting a pull request, please be sure to complete each of the following. + options: + - label: MUST reference this issue, e.g. via `closes [this issue number]`. + required: true + - label: MUST pass the automated CI checks. + required: true