diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index faf8e31..f6b4044 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,30 +1,42 @@ -name: "\U0001F41E Bug report" +name: 🐞 Bug report description: Report broken functionality. labels: [bug] + body: - type: markdown attributes: value: | - - Please check existing issues (both opened and closed) to ensure that this bug hasn't been reported before. - - If you want to ask a question instead of reporting a bug, use [discussions](https://github.com/Tyrrrz/CliFx/discussions/new) instead. + 🧐 **Guidelines:** + + - Search through [existing issues](https://github.com/Tyrrrz/CliFx/issues?q=is%3Aissue) first to ensure that this bug has not been reported before. + - Write a descriptive title for your issue. Avoid generic or vague titles such as "Something's not working" or "A couple of problems". + - Keep your issue focused on one single problem. If you have multiple bug reports, please create separate issues for each of them. + - Provide as much context as possible in the details section. Include screenshots, screen recordings, links, references, or anything else you may consider relevant. + - If you want to ask a question instead of reporting a bug, please use [discussions](https://github.com/Tyrrrz/CliFx/discussions/new) instead. - type: input attributes: label: Version - description: "Which version(s) of CliFx does this bug affect?" + description: Which version of CliFx does this bug affect? + placeholder: ver X.Y.Z validations: required: true - type: textarea attributes: label: Details - description: "Clear and thorough explanation of the bug. If relevant, include screenshots or screen recordings." + description: Clear and thorough explanation of the bug. + placeholder: I was doing X expecting Y to happen, but Z happened instead. validations: required: true - type: textarea attributes: label: Steps to reproduce - description: "Minimum steps or code required to reproduce the bug." + description: Minimum steps required to reproduce the bug. + placeholder: | + - Step 1 + - Step 2 + - Step 3 validations: required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index ba8d12a..d7ef0b5 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - - name: "\U0001F5E8 Ask a question" + - name: 🗨 Discussions url: https://github.com/Tyrrrz/CliFx/discussions/new - about: Please ask and answer questions here. \ No newline at end of file + about: Ask and answer questions. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 1fe2d98..229d045 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,16 +1,22 @@ -name: "\U00002728 Feature request" +name: ✨ Feature request description: Request a new feature. labels: [enhancement] + body: - type: markdown attributes: value: | - - Please check existing issues (both opened and closed) to ensure that this feature hasn't been requested before. - - If you want to ask a question instead of requesting a feature, use [**discussions**](https://github.com/Tyrrrz/CliFx/discussions/new) instead. + 🧐 **Guidelines:** + + - Search through [existing issues](https://github.com/Tyrrrz/CliFx/issues?q=is%3Aissue) first to ensure that this feature has not been requested before. + - Write a descriptive title for your issue. Avoid generic or vague titles such as "Some suggestions" or "Ideas for improvement". + - Keep your issue focused on one single problem. If you have multiple feature requests, please create separate issues for each of them. + - Provide as much context as possible in the details section. Include screenshots, screen recordings, links, references, or anything else you may consider relevant. + - If you want to ask a question instead of requesting a feature, please use [discussions](https://github.com/Tyrrrz/CliFx/discussions/new) instead. - type: textarea attributes: label: Details - description: "Clear and thorough explanation of the feature you have in mind." + description: Clear and thorough explanation of the feature you have in mind. validations: required: true \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..d8cd1fb --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,17 @@ + + + +Closes #ISSUE_NUMBER \ No newline at end of file