From 72f6a996ca5eafdd8ac5dc300633df4baace952b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sergio=20La=C3=ADn?= Date: Fri, 5 Jan 2024 18:26:45 +0100 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20feat(docs):=20added=20issue=20and?= =?UTF-8?q?=20pull=20request=20templates?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/bug_report.yml | 70 ++++++++++++++++++- .github/ISSUE_TEMPLATE/custom.md | 1 - .../ISSUE_TEMPLATE/documentation_update.yml | 37 +++++++++- .github/ISSUE_TEMPLATE/feature_request.yml | 37 +++++++++- .github/PULL_REQUEST_TEMPLATE.md | 39 ++++++++++- 5 files changed, 179 insertions(+), 5 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/custom.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index cfe3cb45..f4a28473 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1 +1,69 @@ -# TODO: Create yml template +name: "🐛 Bug Report" +description: Create a bug/issue report +title: "🐛 [BUG] - " +labels: ["bug"] +body: + - type: checkboxes + attributes: + label: Did you check existing issues? + description: Make sure you checked all of the below before submitting an issue to avoid duplicates + options: + - label: I have searched the existing issues of the repo + required: true + - label: I have searched the existing issues of used programs related to this issue + required: true + - type: textarea + id: description + attributes: + label: "Description of the bug" + description: A clear and concise description of what the bug is. + render: bash + 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. And so on... + render: bash + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: screenshot + attributes: + label: "Screenshots" + description: If needed, 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: textarea + id: environment + attributes: + label: "Environment" + description: Please add any relevant information about your environment. + value: | + Linux Distro, Linux Version, Hyprland Version... + render: bash + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md deleted file mode 100644 index 69d6ea49..00000000 --- a/.github/ISSUE_TEMPLATE/custom.md +++ /dev/null @@ -1 +0,0 @@ -# TODO: Create md template diff --git a/.github/ISSUE_TEMPLATE/documentation_update.yml b/.github/ISSUE_TEMPLATE/documentation_update.yml index cfe3cb45..4dced320 100644 --- a/.github/ISSUE_TEMPLATE/documentation_update.yml +++ b/.github/ISSUE_TEMPLATE/documentation_update.yml @@ -1 +1,36 @@ -# TODO: Create yml template +name: "📚 Documentation Update" +description: Suggest a new change in the repo documentation +title: "📚 [DOC UPDATE] - <title>" +labels: ["documentation"] +body: + - type: checkboxes + attributes: + label: Did you check existing doc request? + description: Make sure you checked all of the below before submitting a request to avoid duplicates + options: + - label: I have searched the existing requests of the repo + required: true + - type: textarea + validations: + required: true + attributes: + label: Description of the request + description: A clear description of the documentation update. + - type: input + validations: + required: true + attributes: + label: Current Documentation + description: Provide a link to the current documentation or describe where it can be found. + - type: textarea + validations: + required: true + attributes: + label: Proposed Documentation + description: Provide a clear description of the updated documentation. + - type: textarea + validations: + required: false + attributes: + label: Additional Context + description: Add any other information about the documentation update here. For example, you might include links to similar documentation in other projects, or screenshots or diagrams to help explain your idea. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index cfe3cb45..c814eb61 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1 +1,36 @@ -# TODO: Create yml template +name: "💡 Feature Request" +description: Suggest a new feature request +title: "💡 [REQUEST] - <title>" +labels: ["enhancement"] +body: + - type: checkboxes + attributes: + label: Did you check existing feature request? + description: Make sure you checked all of the below before submitting a request to avoid duplicates + options: + - label: I have searched the existing requests of the repo + required: true + - type: textarea + validations: + required: true + attributes: + label: Is your feature request related to a problem? Please describe. + description: A clear description of what the problem is. + - type: textarea + validations: + required: true + attributes: + label: Describe the solution you'd like + description: A clear description of what you want to happen. + - type: textarea + validations: + required: true + attributes: + label: Describe alternatives you've considered + description: A clear description of any alternative solutions or features you've considered. Here you can include pull request links if needed. + - type: textarea + validations: + required: false + attributes: + label: Additional Context + description: Add any other context or screenshots about the feature request here. Here you can include issue links if needed. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 69d6ea49..adba2e5c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1 +1,38 @@ -# TODO: Create md template +## 🌿 Description + +**Include a summary of the changes and which issue is fixed** + +**List any dependencies that are required for this change. (e.g., packages or other PRs)** + +**Provide a link if there is an issue related to this pull request. e.g., Fixes # (issue)** + +## 📝 Type of change + +Please put an `x` in the boxes that apply: + +- [ ] **Bug fix** (non-breaking change which fixes an issue) +- [ ] **New feature** (non-breaking change which adds functionality) +- [ ] **Breaking change** (fix or feature that would cause existing functionality to not work as expected) +- [ ] **Documentation update** (non-breaking change; modified files are limited to the documentations) +- [ ] **Technical debt** (a code change that does not fix a bug or add a feature but makes something clearer) +- [ ] **Other** (provide details below) + +## 🔎 Checklist + +Please put an `x` in the boxes that apply: + +- [ ] I have read the [CONTRIBUTING](./CONTRIBUTING.md) document. +- [ ] My code follows the code style of this project. +- [ ] My commit message follows the [commit guidelines](./COMMIT_MESSAGE_GUIDELINES.md). +- [ ] My change requires a change to the documentation. +- [ ] I have updated the documentation accordingly. +- [ ] I have added necessary comments/documentation to my code. +- [ ] I have tested my code locally and it works as expected. + +## 📸 Screenshots + +(if appropriate) + +## ✏️ Additional context + +Add any other context about the pull request here.