From 6c71b9fa4a711b2cdaa7fb2f5f716b6e83df2853 Mon Sep 17 00:00:00 2001 From: JohnAlbin Date: Sat, 7 Oct 2023 00:39:05 +0800 Subject: [PATCH] chore: add issue queue form templates Added a GitHub pull request template and GitHub forms for bug reports, feature requests and questions. --- .github/ISSUE_TEMPLATE/bug_report.yml | 68 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 57 ++++++++++++++++++ .github/ISSUE_TEMPLATE/question.yml | 54 +++++++++++++++++ .github/pull_request_template.md | 26 +++++++++ 4 files changed, 205 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.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 00000000..26ba77cc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,68 @@ +# Useful docs: +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema + +name: Bug Report +description: File a bug report +# title: "[Bug]: " +labels: ["bug", "triage"] +# projects: ["octo-org/1", "octo-org/44"] +#assignees: +# - octocat +body: + - type: dropdown + id: package + attributes: + label: Package containing the bug + description: What package in this monorepo has the bug? + options: + - I’m not sure + - next (Drupal module) + - next-drupal (NPM package) + - basic-starter + - graphql-starter + - example-auth + - example-blog + - example-client + - example-custom-auth + - example-custom-cache + - example-custom-fetcher + - example-custom-serializer + - example-graphql + - example-marketing + - example-query + - example-search-api + - example-umami + - example-webform + default: 0 + validations: + required: true + - type: textarea + id: description + attributes: + label: Describe the bug + value: | + A clear and concise description of what the bug is. + + If applicable, add screenshots to help explain your problem. + + ### Expected behavior + + A clear and concise description of what you expected to happen. + + ### Steps to reproduce: + + 1. First '...' + 2. Then '....' + 3. 😢 + + ### Additional context + + Add any other context about the problem here. + validations: + required: true + - type: markdown + attributes: + value: | +

Thanks for taking the time to fill out this bug report!

diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..1b873fa7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,57 @@ +name: Feature Request +description: Suggest an idea for this project +# title: "[Feature]: " +labels: ["enhancement", "triage"] +# projects: ["octo-org/1", "octo-org/44"] +#assignees: +# - octocat +body: + - type: dropdown + id: package + attributes: + label: Package + description: The feature request is for what package in this monorepo? + options: + - I’m not sure + - next (Drupal module) + - next-drupal (NPM package) + - basic-starter + - graphql-starter + - example-auth + - example-blog + - example-client + - example-custom-auth + - example-custom-cache + - example-custom-fetcher + - example-custom-serializer + - example-graphql + - example-marketing + - example-query + - example-search-api + - example-umami + - example-webform + default: 0 + validations: + required: true + - type: textarea + id: description + attributes: + label: Describe the feature request + value: | + A clear and concise description of what the request is. If your feature request is related to a problem, please describe it. + + If applicable, add screenshots to help explain your issue. + + ### Describe the solution you'd like + + ### Describe alternatives you've considered + + ### Additional context + + Add any other context about the problem here. + validations: + required: true + - type: markdown + attributes: + value: | +

Thanks for taking the time to fill out this feature request!

diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 00000000..e5ff3b98 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,54 @@ +name: Question +description: Ask a question or make a support request +# title: "[Support]: " +labels: ["question", "triage"] +# projects: ["octo-org/1", "octo-org/44"] +#assignees: +# - octocat +body: + - type: dropdown + id: package + attributes: + label: Package + description: The question is for what package in this monorepo? + options: + - Not applicable + - I’m not sure + - next (Drupal module) + - next-drupal (NPM package) + - basic-starter + - graphql-starter + - example-auth + - example-blog + - example-client + - example-custom-auth + - example-custom-cache + - example-custom-fetcher + - example-custom-serializer + - example-graphql + - example-marketing + - example-query + - example-search-api + - example-umami + - example-webform + default: 1 + validations: + required: true + - type: textarea + id: description + attributes: + label: Ask the question + value: | + A clear and concise description of what the question is. + + If applicable, add screenshots to help explain your issue. + + ### Additional context + + Add any other context about the question here. + validations: + required: true + - type: markdown + attributes: + value: | +

Thanks for taking the time to fill out this request form!

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..4bf7253d --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,26 @@ +### This pull request is for: (choose one) + +- [ ] `examples/*` +- [ ] `modules/next` +- [ ] `packages/next-drupal` +- [ ] `starters/basic-starter` +- [ ] `starters/graphql-starter` +- [ ] Other + +### Describe your changes + +A clear and concise description of what the request is. + +Note: + +- Work-in-progress PRs are fine. So that we can tell this + PR needs additional work, please prefix the title of this + PR with: `WIP: ` +- Bug fixes and feature requests need tests that cover the + new code. If you don't know how to make the appropriate + tests, submit the PR anyway and ask for help. Please + prefix the title of this PR with: `NEEDS TESTS: ` + +### Link to GitHub Issue + +Please add a link to the GitHub issue where this problem is discussed.