Skip to content

Commit

Permalink
chore: add issue queue form templates
Browse files Browse the repository at this point in the history
Added a GitHub pull request template and GitHub forms for bug reports, feature
requests and questions.

Fixes #531
  • Loading branch information
JohnAlbin committed Oct 10, 2023
1 parent 0ed773e commit 5c7a006
Show file tree
Hide file tree
Showing 4 changed files with 188 additions and 0 deletions.
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# 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
labels: ["bug", "triage"]
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: |
<p align="right"><em><strong>Thanks</strong> for taking the time to fill out this bug report!</em></p>
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Feature Request
description: Suggest an idea for this project
labels: ["enhancement", "triage"]
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: |
<p align="right"><em><strong>Thanks</strong> for taking the time to fill out this feature request!</em></p>
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Question
description: Ask a question or make a support request
labels: ["question", "triage"]
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: |
<p align="right"><em><strong>Thanks</strong> for taking the time to fill out this request form!</em></p>
21 changes: 21 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
This pull request is for: (mark with an "x")
- [ ] `examples/*`
- [ ] `modules/next`
- [ ] `packages/next-drupal`
- [ ] `starters/basic-starter`
- [ ] `starters/graphql-starter`
- [ ] Other

GitHub Issue: #
_Please add a link to the GitHub issue
where this problem is discussed._

- [ ] I need help adding tests. (mark with an "x")
_Code changes need test coverage. If you don't know
how to make tests, check this box to ask for help._

## Describe your changes

A clear and concise description of what the request is.

If applicable, add screenshots to help explain your issue.

0 comments on commit 5c7a006

Please sign in to comment.