From fcefb80fa633b9933c79fdb3424a3a44bf054fef Mon Sep 17 00:00:00 2001 From: "Quang (Albert)" Date: Wed, 28 Aug 2024 17:18:50 +0700 Subject: [PATCH] feat: Add contribution templates (#none) (#139) * feat: Add PR template * feat: Add issue templates * style: Comfort pre-commit * style: Comfort pre-commit --- .github/ISSUE_TEMPLATE/bug_report.yml | 85 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature_request.yml | 49 +++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 18 +++++ 4 files changed, 153 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..aa6b9f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,85 @@ +name: "Bug Report" +description: Report something that is not working as expected +title: "[BUG] - " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + *Please fill this form with as much information as possible.* + - 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: 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 + - Brave + - Other + validations: + required: false + - type: dropdown + id: os + attributes: + label: "OS" + description: What is the impacted environment ? + multiple: true + options: + - Windows + - MacOS + - Linux + - Other + validations: + required: false + - type: textarea + id: additional_information + attributes: + label: "Additional information" + description: Add any relevant information or context. + placeholder: + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..f11979b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,49 @@ +name: "Feature Request" +description: Brainstorm and propose new features for the project +title: "[REQUEST] - <title>" +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + *Please fill this form with as much information as possible.* + - type: textarea + id: reference_issues + attributes: + label: "Reference Issues" + description: Common issues + placeholder: "#Issues IDs" + validations: + required: false + - type: textarea + id: summary + attributes: + label: "Summary" + description: Provide a brief explanation of the feature + placeholder: Describe in a few lines your feature request + validations: + required: true + - type: textarea + id: basic_example + attributes: + label: "Basic Example" + description: Indicate here some basic examples of your feature. + placeholder: A few specific words about your feature request. + validations: + required: true + - type: textarea + id: drawbacks + attributes: + label: "Drawbacks" + description: What are the drawbacks/impacts of your feature request ? + placeholder: Identify the drawbacks and impacts while being neutral on your feature request + validations: + required: true + - type: textarea + id: additional_information + attributes: + label: "Additional information" + description: Add any additional information that you think is important for your feature request + placeholder: + validations: + required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..162d466 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,18 @@ +## Description + +- Please include a summary of the changes and the related issue. +- Fixes # (issue) + +## Type of change + +- [ ] New features (non-breaking change). +- [ ] Bug fix (non-breaking change). +- [ ] Breaking change (fix or feature that would cause existing functionality not to work as expected). + +## Checklist + +- [ ] I have performed a self-review of my code. +- [ ] I have added thorough tests if it is a core feature. +- [ ] There is a reference to the original bug report and related work. +- [ ] I have commented on my code, particularly in hard-to-understand areas. +- [ ] The feature is well documented.