From 203de18053abb54bc8f4d17afb55cf00fb8372f8 Mon Sep 17 00:00:00 2001 From: Ezra Adeyinka Date: Tue, 3 Oct 2023 12:47:10 +0100 Subject: [PATCH 1/5] ci(root): add bug report issue form template directive --- .github/ISSUE_TEMPLATE/bug_report.yml | 112 ++++++++++++++++++++++++++ 1 file changed, 112 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..17884ea8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,112 @@ +name: "🐛 Bug Report" +description: "Submit a bug report to help us improve" +title: "🐛 Bug Report: " +labels: ["type: bug"] +body: + - type: markdown + attributes: + value: We value your time and your efforts to submit this bug report is appreciated. 🙏 + - type: textarea + id: description + validations: + required: true + attributes: + label: "📜 Description" + description: "A clear and concise description of what the bug is." + placeholder: "It bugs out when ..." + - type: textarea + id: steps-to-reproduce + validations: + required: true + attributes: + label: "👟 Reproduction steps" + description: "How do you trigger this bug? Please walk us through it step by step." + placeholder: "1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error" + - type: textarea + id: expected-behavior + validations: + required: true + attributes: + label: "👍 Expected behavior" + description: "What did you think should happen?" + placeholder: "It should ..." + - type: textarea + id: actual-behavior + validations: + required: true + attributes: + label: "👎 Actual Behavior with Screenshots" + description: "What did actually happen? Add screenshots, if applicable." + placeholder: "It actually ..." + - type: dropdown + id: operating-system + attributes: + label: "💻 Operating system" + description: "What OS is your app running on?" + options: + - Linux + - MacOS + - Windows + - Something else + validations: + required: true + - type: dropdown + id: browsers + attributes: + label: What browsers are you seeing the problem on? + multiple: true + options: + - Firefox + - Chrome + - Safari + - Microsoft Edge + - Something else + + - type: input + id: node-version + validations: + required: true + attributes: + label: "🤖 Node Version" + description: > + What Node version are you using? + - type: textarea + id: additional-context + validations: + required: false + attributes: + label: "📃 Provide any additional context for the Bug." + description: "Add any other context about the problem here." + placeholder: "It actually ..." + - type: textarea + id: logs + validations: + required: false + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "👀 Have you spent some time to check if this bug has been raised before?" + options: + - label: "I checked and didn't find similar issue" + required: true + - type: dropdown + attributes: + label: Are you willing to submit PR? + description: + This is absolutely not required, but we are happy to guide you in the contribution process. + - "Yes I am willing to submit a PR!" + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) + options: + - label: I agree to follow this project's Code of Conduct + required: true From a8f6d2adf0577c4a52cf22c847ea2db2b0c58a0b Mon Sep 17 00:00:00 2001 From: Ezra Adeyinka Date: Tue, 3 Oct 2023 13:02:24 +0100 Subject: [PATCH 2/5] ci(root): add feature request issue form template directive --- .github/ISSUE_TEMPLATE/feature_request.yml | 54 ++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..34323234 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,54 @@ +name: 🚀 Feature +description: "Submit a proposal for a new feature" +title: "🚀 Feature: " +labels: [feature] +body: + - type: markdown + attributes: + value: We value your time and your efforts to submit this bug report is appreciated. 🙏 + - type: textarea + id: feature-description + validations: + required: true + attributes: + label: "🔖 Feature description" + description: "A clear and concise description of what the feature is." + placeholder: "You should add ..." + - type: textarea + id: pitch + validations: + required: true + attributes: + label: "🎤 Why is this feature needed ?" + description: "Please explain why this feature should be implemented and how it would be used. Add examples, if applicable." + placeholder: "In my use-case, ..." + - type: textarea + id: solution + validations: + required: true + attributes: + label: "✌️ How do you aim to achieve this?" + description: "A clear and concise description of what you want to happen." + placeholder: "I want this feature to, ..." + - type: textarea + id: alternative + validations: + required: false + attributes: + label: "🔄️ Additional Information" + description: "A clear and concise description of any alternative solutions or additional solutions you've considered." + placeholder: "I tried, ..." + - type: checkboxes + id: no-duplicate-issues + attributes: + label: "👀 Have you spent some time to check if this feature request has been raised before?" + options: + - label: "I checked and didn't find similar issue" + required: true + - type: dropdown + id: willing-to-submit-pr + attributes: + label: Are you willing to submit PR? + description: This is absolutely not required, but we are happy to guide you in the contribution process. + options: + - "Yes I am willing to submit a PR!" From 1cca46cf7b30583f4dfaee5b0d1ab9e456cd1251 Mon Sep 17 00:00:00 2001 From: Ezra Adeyinka Date: Tue, 3 Oct 2023 13:04:32 +0100 Subject: [PATCH 3/5] ci(root): add pull request markdown template --- .github/PULL_REQUEST_TEMPLATE.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..925606ba --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,5 @@ +- **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) + +- **Why was this change needed?** (You can also link to an open issue here) + +- **Other information**: \ No newline at end of file From 932b504d82683737851e599e7bef70d8953fce89 Mon Sep 17 00:00:00 2001 From: Ezra Adeyinka Date: Tue, 3 Oct 2023 14:22:53 +0100 Subject: [PATCH 4/5] fix(bug_report_template): append working code of conduct url --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 17884ea8..873d9fca 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -106,7 +106,7 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com) + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/arc53/DocsGPT/blob/main/CODE_OF_CONDUCT.md) options: - label: I agree to follow this project's Code of Conduct required: true From b6f78ce1af523a71a89293573ad5f1269e117528 Mon Sep 17 00:00:00 2001 From: Ezra Adeyinka Date: Tue, 3 Oct 2023 14:39:56 +0100 Subject: [PATCH 5/5] fix(bug_report_template): add environments and variable constructs --- .github/ISSUE_TEMPLATE/bug_report.yml | 37 +++++++++++++++++++++------ 1 file changed, 29 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 873d9fca..70459f53 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -6,6 +6,7 @@ body: - type: markdown attributes: value: We value your time and your efforts to submit this bug report is appreciated. 🙏 + - type: textarea id: description validations: @@ -14,6 +15,7 @@ body: label: "📜 Description" description: "A clear and concise description of what the bug is." placeholder: "It bugs out when ..." + - type: textarea id: steps-to-reproduce validations: @@ -25,6 +27,7 @@ body: 2. Click on '....' 3. Scroll down to '....' 4. See error" + - type: textarea id: expected-behavior validations: @@ -33,6 +36,7 @@ body: label: "👍 Expected behavior" description: "What did you think should happen?" placeholder: "It should ..." + - type: textarea id: actual-behavior validations: @@ -41,6 +45,7 @@ body: label: "👎 Actual Behavior with Screenshots" description: "What did actually happen? Add screenshots, if applicable." placeholder: "It actually ..." + - type: dropdown id: operating-system attributes: @@ -53,6 +58,7 @@ body: - Something else validations: required: true + - type: dropdown id: browsers attributes: @@ -65,14 +71,25 @@ body: - Microsoft Edge - Something else - - type: input - id: node-version + - type: dropdown + id: dev-environment validations: required: true attributes: - label: "🤖 Node Version" - description: > - What Node version are you using? + label: "🤖 What development environment are you experiencing this bug on?" + options: + - Docker + - Local dev server + + - type: textarea + id: env-vars + validations: + required: false + attributes: + label: "🔒 Did you set the correct environment variables in the right path? List the environment variable names (not values please!)" + description: "Please refer to the [Project setup instructions](https://github.com/arc53/DocsGPT#quickstart) if you are unsure." + placeholder: "It actually ..." + - type: textarea id: additional-context validations: @@ -81,14 +98,16 @@ body: label: "📃 Provide any additional context for the Bug." description: "Add any other context about the problem here." placeholder: "It actually ..." + - type: textarea id: logs validations: required: false attributes: - label: Relevant log output + label: 📖 Relevant log output description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. render: shell + - type: checkboxes id: no-duplicate-issues attributes: @@ -96,16 +115,18 @@ body: options: - label: "I checked and didn't find similar issue" required: true + - type: dropdown attributes: - label: Are you willing to submit PR? + label: 🔗 Are you willing to submit PR? description: This is absolutely not required, but we are happy to guide you in the contribution process. - "Yes I am willing to submit a PR!" + - type: checkboxes id: terms attributes: - label: Code of Conduct + label: 🧑‍⚖️ Code of Conduct description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/arc53/DocsGPT/blob/main/CODE_OF_CONDUCT.md) options: - label: I agree to follow this project's Code of Conduct