forked from nextauthjs/next-auth
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: use issue template forms (nextauthjs#2274)
* (docs) initial issue template forms as per nextauthjs#2271 * (typo) fix grammar and typo * (forms) make the requested changes * (chore) delete the old .md files * (forms) fix type key
- Loading branch information
1 parent
13e56bc
commit 797272a
Showing
8 changed files
with
283 additions
and
150 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
name: Bug Report | ||
description: File a bug report | ||
title: "[Bug]: " | ||
labels: bug | ||
|
||
# note: markdown sections will NOT appear as part of the issue as per documentation, rather they provide context to the user | ||
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#markdown | ||
|
||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! Please provide the following information: | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Description 🐜 | ||
description: Please provide a clear and concise description of the bug in NextAuth.js | ||
validations: | ||
required: true | ||
|
||
- type: dropdown | ||
id: ownproject | ||
attributes: | ||
label: Is this a bug in your own project? | ||
description: 🚧 – _Do not report bugs with your own project here; ask for help [by raising a question instead](https://github.com/nextauthjs/next-auth/issues/new?assignees=&labels=question&template=question.md) or use the [Discussions tab](https://github.com/nextauthjs/next-auth/discussions) - this helps us reduce the maintenance overhead._ | ||
multiple: false | ||
options: | ||
- "Yes" | ||
- "No" | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
id: reproduction | ||
attributes: | ||
label: How to reproduce ☕️ | ||
description: Please provide a link or code snippets to a minimal reproduction of the bug | ||
validations: | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: | | ||
We encourage you to use one of the templates set up on **CodeSandbox** to reproduce your issue: | ||
- [`next-auth-example`](https://codesandbox.io/s/next-auth-example-1kktb) | ||
- [`next-auth-typescript-example`](https://codesandbox.io/s/next-auth-typescript-example-se32w) | ||
🚧 – _If you don't provide any way to reproduce the bug, the issue is at risk of being closed._ | ||
- type: textarea | ||
id: logs | ||
attributes: | ||
label: Screenshots / Logs 📽 | ||
description: We can address the bug you found much faster if you provide contextual screenshots or screen recordings showcasing the issue. | ||
- type: markdown | ||
attributes: | ||
value: | | ||
See [Kap](https://getkap.co/) for a good, easy-to-use, cross-platform screen recording tool. | ||
validations: | ||
required: false | ||
|
||
- type: textarea | ||
id: environment | ||
attributes: | ||
label: Environment 🖥 | ||
validations: | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Please run this command in your project's root folder: | ||
```sh | ||
npx envinfo --system --binaries --browsers --npmPackages "next,next-auth,react" | ||
``` | ||
- type: dropdown | ||
id: pr | ||
attributes: | ||
label: Contributing 🙌🏽 | ||
multiple: false | ||
options: | ||
- "Yes, I am willing to help solve this bug in a PR" | ||
- "No, I am afraid I cannot help regarding this" | ||
validations: | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: | | ||
It takes a lot of work 🏋🏻♀️ maintaining a library like `next-auth`; any contribution is more than welcome 💚 | ||
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
name: Feature Request | ||
description: Suggest an idea for NextAuth.js | ||
title: "[Feature Request]: " | ||
labels: enhancement | ||
|
||
# note: markdown sections will NOT appear as part of the issue as per documentation, rather they provide context to the user | ||
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#markdown | ||
|
||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you very much for reaching out to us regarding the awesome feature that you believe should be included in the NextAuth.js library. Please provide the following information: | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Description 📓 | ||
description: Please provide a more in-depth description of the feature proposed. | ||
validations: | ||
required: true | ||
|
||
- type: markdown | ||
attributes: | ||
value: | | ||
Make sure you provide plenty of [links]() to external documentation and inline code examples like so: | ||
```js | ||
function myAwesomeNextAuthFeature() { | ||
return 💚 | ||
} | ||
``` | ||
Take time thinking about what you want to say and help us understand your proposal making sure that this description contains: | ||
- **purpose of the feature** | ||
- **potential problems** | ||
- **potential alternatives** | ||
- type: textarea | ||
id: reproduction | ||
attributes: | ||
label: How to reproduce ☕️ | ||
description: If you have a CodeSandbox playground or some code snippets to help us visualize your idea better, please provide it here. | ||
validations: | ||
required: false | ||
- type: markdown | ||
attributes: | ||
value: | | ||
You can use one of the templates set up on **CodeSandbox** to better illustrate your idea: | ||
- [`next-auth-example`](https://codesandbox.io/s/next-auth-example-1kktb) | ||
- [`next-auth-typescript-example`](https://codesandbox.io/s/next-auth-typescript-example-se32w) | ||
- type: dropdown | ||
id: pr | ||
attributes: | ||
label: Contributing 🙌🏽 | ||
multiple: false | ||
options: | ||
- "Yes, I am willing to help implement this feature in a PR" | ||
- "No, I am afraid I cannot help regarding this" | ||
validations: | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: | | ||
It takes a lot of work 🏋🏻♀️ maintaining a library like `next-auth`; any contribution is more than welcome 💚 | ||
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
name: Question | ||
description: Ask a question about NextAuth.js or for help using it | ||
title: "[Question]: " | ||
labels: question | ||
|
||
# note: markdown sections will NOT appear as part of the issue as per documentation, rather they provide context to the user | ||
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#markdown | ||
|
||
body: | ||
|
||
- type: markdown | ||
attributes: | ||
value: | | ||
We are glad that you have a question about this library. Please provide the following information: | ||
- type: textarea | ||
id: question | ||
attributes: | ||
label: Question 💬 | ||
description: Please provide an in-depth description of the question you have. | ||
validations: | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Make sure you [link]() to external documentation if necessary and provide inline code examples like so: | ||
```js | ||
function myAwesomeNextAuthFeature() { | ||
return 💚 | ||
} | ||
``` | ||
**NOTE:** Questions will be converted to Discussions. You can find them [here](https://github.com/nextauthjs/next-auth/discussions)! | ||
- type: textarea | ||
id: reproduction | ||
attributes: | ||
label: How to reproduce ☕️ | ||
description: Please provide a link to a minimal reproduction or code snippets that represents your question | ||
validations: | ||
required: false | ||
- type: markdown | ||
attributes: | ||
value: | | ||
We encourage you to use the template set-up on **CodeSandbox** as a playground to represent your question or doubt: | ||
- [`next-auth-example`](https://codesandbox.io/s/next-auth-example-1kktb) | ||
- type: dropdown | ||
id: pr | ||
attributes: | ||
label: Contributing 🙌🏽 | ||
multiple: false | ||
options: | ||
- "Yes, I am willing to help answer this question in a PR" | ||
- "No, I am afraid I cannot help regarding this" | ||
validations: | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: | | ||
It takes a lot of work 🏋🏻♀️ maintaining a library like `next-auth`; any contribution is more than welcome 💚 | ||
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.