3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-29 10:17:55 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore: switch to GitHub issue forms (#5836)

Browse source
This commit is contained in:
Alexey Pyltsyn 2021-10-30 17:08:14 +03:00 • committed by GitHub
parent d576b28e70
commit 6ccda86e0f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 277 additions and 266 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

119
.github/ISSUE_TEMPLATE/bug.md vendored
View file

@ -1,119 +0,0 @@
---
name: 🐛 Bug Report
about: Submit a bug report to help us improve
labels: 'bug, needs triage'
---
<!--
! PLEASE HELP US HELP YOU !
Make it obvious to understand and reproduce this bug.
Ideally, we should be able to understand it without running any code.
Bugs are fixed faster if you include:
- a repro repository to inspect the code
- an url to see the problem live (if possible)
Pro tip: create a reproducible demo of the bug with https://new.docusaurus.io
-->
## 🐛 Bug Report
### Prerequisites
<!--
IMPORTANT: Please check the following items before creating a issue.
Mark the checkbox by replacing the space between the brackets with an X (- [X]).
This way we know you've done these steps first.
-->
- [ ] I'm using the latest version of Docusaurus.
- [ ] I have tried the `npm run clear` or `yarn clear` command.
- [ ] I have tried `rm -rf node_modules yarn.lock package-lock.json` and re-installing packages.
- [ ] I have tried creating a repro with https://new.docusaurus.io
- [ ] I have read the console error message carefully (if applicable)
### Description
(A clear and concise description of what the bug is.)
### Have you read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#reporting-new-issues)?
(Write your answer here.)
## Steps to reproduce
Use https://new.docusaurus.io to create a CodeSandbox reproducible demo of the bug.
(Write your steps here.)
1. Step 1...
2. Step 2...
3. Step 3...
## Expected behavior
<!--
How did you expect your project to behave?
It’s fine if you’re not sure your understanding is correct.
Write down what you thought would happen.
-->
(Write what you thought would happen.)
## Actual behavior
<!--
Did something go wrong?
Is something broken, or not behaving as you expected?
Describe this section in detail, and attach screenshots if possible.
Don't only say "it doesn't work"!
Please submit exhaustive and complete log messages (we also need the error stack-traces, not just the message).
Please read error messages carefully: it often tells you exactly what you are doing wrong.
-->
(Write what happened. Add full console log messages and screenshots, if applicable.)
## Your environment
<!-- Include as many relevant details about the environment you experienced the bug in -->
- Public source code:
- Public site URL:
- Docusaurus version used:
- Environment name and version (e.g. Chrome 78.0.3904.108, Node.js 10.17.0):
- Operating system and version (e.g. Ubuntu 20.04.2 LTS):
## Reproducible demo
Use https://new.docusaurus.io to create a CodeSandbox reproducible demo of the bug.
(Paste the link to an example repo, including a `docusaurus.config.js`, and exact instructions to reproduce the issue.)
<!--
What happens if you skip this step?
Someone will read your bug report, and maybe will be able to help you,
but it’s unlikely that it will get much attention from the team. Eventually,
the issue will likely get closed in favor of issues that have reproducible demos.
Please remember that:
* Issues without reproducible demos have a very low priority.
* The person fixing the bug would have to do that anyway. Please be respectful of their time.
* You might figure out the issues yourself as you work on extracting it.
Thanks for helping us help you!
-->
### Self-service
<!--
If you feel like you could contribute to this issue, please check the box below by replacing the space with an X (- [X]).
This would tell us and other people looking for contributions that someone's working on it.
If you do check this box, please send a pull request within 7 days so we can still delegate this to someone else.
-->
- [ ] I'd be willing to fix this bug myself.

113
.github/ISSUE_TEMPLATE/bug.yml vendored Normal file
View file

@ -0,0 +1,113 @@
name: 🐛 Bug Report
description: Submit a bug report to help us improve
labels: [bug, needs triage]
body:
- type: markdown
attributes:
value: |
## Please help us help you!
Make it obvious to understand and reproduce this bug. Ideally, we should be able to understand it without running any code.
Bugs are fixed faster if you include:
- A repro repository to inspect the code
- An url to see the problem live (if possible)
Pro tip: create a reproducible demo of the bug with https://new.docusaurus.io.
- type: checkboxes
attributes:
label: Have you read the Contributing Guidelines on issues?
options:
- label: I have read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#reporting-new-issues).
required: true
- type: checkboxes
attributes:
label: Prerequisites
description: Please check the following items before creating a issue. This way we know you've done these steps first.
options:
- label: I'm using the latest version of Docusaurus.
required: true
- label: I have tried the `npm run clear` or `yarn clear` command.
- label: I have tried `rm -rf node_modules yarn.lock package-lock.json` and re-installing packages.
- label: I have tried creating a repro with https://new.docusaurus.io.
- label: I have read the console error message carefully (if applicable).
- type: textarea
attributes:
label: Description
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: Use https://new.docusaurus.io to create a CodeSandbox reproducible demo of the bug.
placeholder: |
Write your steps here.
1. Step 1...
2. Step 2...
3. Step 3...
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: |
How did you expect your project to behave? It’s fine if you’re not sure your understanding is correct. Write down what you thought would happen.
placeholder: Write what you thought would happen.
validations:
required: true
- type: textarea
attributes:
label: Actual behavior
description: |
Did something go wrong? Is something broken, or not behaving as you expected?
Describe this section in detail, and attach screenshots if possible. Don't only say "it doesn't work"!
Please submit exhaustive and complete log messages (we also need the error stack-traces, not just the message).
> Please read error messages carefully: it often tells you exactly what you are doing wrong.
placeholder: Write what happened. Add full console log messages and screenshots, if applicable.
validations:
required: true
- type: textarea
attributes:
label: Your environment
description: Include as many relevant details about the environment you experienced the bug in.
value: |
- Public source code:
- Public site URL:
- Docusaurus version used:
- Environment name and version (e.g. Chrome 89, Node.js 16.4):
- Operating system and version (e.g. Ubuntu 20.04.2 LTS):
- type: input
attributes:
label: Reproducible demo
description: |
Paste the link to an example repo, including a `docusaurus.config.js`, and exact instructions to reproduce the issue. Use https://new.docusaurus.io to create a CodeSandbox reproducible demo of the bug.
> **What happens if you skip this step?** Someone will read your bug report, and maybe will be able to help you, but it’s unlikely that it will get much attention from the team. Eventually, the issue will likely get closed in favor of issues that have reproducible demos.
Please remember that:
- Issues without reproducible demos have a very low priority.
- The person fixing the bug would have to do that anyway. Please be respectful of their time.
- You might figure out the issues yourself as you work on extracting it.
Thanks for helping us help you!
- type: checkboxes
attributes:
label: Self-service
description: |
If you feel like you could contribute to this issue, please check the box below. This would tell us and other people looking for contributions that someone's working on it.
If you do check this box, please send a pull request within 7 days so we can still delegate this to someone else.
options:
- label: I'd be willing to fix this bug myself.

40
.github/ISSUE_TEMPLATE/documentation.md vendored
View file

@ -1,40 +0,0 @@
---
name: 📚 Documentation
about: Report an issue related to documentation
labels: 'documentation, needs triage'
---
<!--
This template is strictly used for documentation requests, including:
- Documenting undocumented APIs;
- Elaborating on a particular topic;
- Updating external links
- ...
i.e. anything that doesn't require touching the codebase itself.
If you followed the documentation but things don't work, take some time to consider if it's the documentation or the code that's wrong. In the latter, prefer using the "bug" template.
We seldom close documentation pull requests unmerged. If your documentation request is:
- Relevant to a significant proportion of Docusaurus users;
- Not about external tooling (e.g. deployment workflow. We have a "deployment" section but we have decided to keep it mostly as-is);
- Not documented elsewhere (or, if it is documented, the mention is in very undiscoverable places),
You may proceed directly to sending a pull request without filing this issue, and we can improve on your work.
If you think some of the requirements above are not met, or if you are not able to contribute yourself, the issue is still welcomed.
-->
## 📚 Documentation
(A clear and concise description of what the issue is.)
### Have you read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md#reporting-new-issues)?
(Write your answer here.)
### Self-service
<!--
If you feel like you could contribute to this issue, please check the box below by replacing the space with an X (- [X]).
This would tell us and other people looking for contributions that someone's working on it.
If you do check this box, please send a pull request within 7 days so we can still delegate this to someone else.
-->
- [ ] I'd be willing to address this documentation request myself.

47
.github/ISSUE_TEMPLATE/documentation.yml vendored Normal file
View file

@ -0,0 +1,47 @@
name: 📚 Documentation
description: Report an issue related to documentation
labels: [documentation, needs triage]
body:
- type: markdown
attributes:
value: |
This template is strictly used for documentation requests, including:
- Documenting undocumented APIs;
- Elaborating on a particular topic;
- Updating external links;
- anything else that doesn't require touching the codebase itself.
If you followed the documentation but things don't work, take some time to consider if it's the documentation or the code that's wrong. In the latter, prefer using the "bug" template.
We seldom close documentation pull requests unmerged. If your documentation request is:
- Relevant to a significant proportion of Docusaurus users;
- Not about external tooling (e.g. deployment workflow. We have a "deployment" section but we have decided to keep it mostly as-is);
- Not documented elsewhere (or, if it is documented, the mention is in very undiscoverable places).
You may proceed directly to sending a pull request without filing this issue, and we can improve on your work.
If you think some of the requirements above are not met, or if you are not able to contribute yourself, the issue is still welcomed.
- type: checkboxes
attributes:
label: Have you read the Contributing Guidelines on issues?
options:
- label: I have read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#reporting-new-issues).
required: true
- type: textarea
attributes:
label: Description
description: A clear and concise description of what the issue is.
validations:
required: true
- type: checkboxes
attributes:
label: Self-service
description: |
If you feel like you could contribute to this issue, please check the box below. This would tell us and other people looking for contributions that someone's working on it.
If you do check this box, please send a pull request within 7 days so we can still delegate this to someone else.
options:
- label: I'd be willing to address this documentation request myself.

69
.github/ISSUE_TEMPLATE/feature.md vendored
View file

@ -1,69 +0,0 @@
---
name: 💅 Feature design / RFC
about: Submit a detailed feature request with a concrete proposal, including an exhaustive API / UI design
labels: 'feature, needs triage'
---
<!--
IMPORTANT:
- We expect you to submit a feature request including a real design (API / UI...), not just a basic idea
- The design does not have to be perfect, we'll discuss it and fix it if needed
- For a more "casual" feature request, consider using Canny instead: https://docusaurus.io/feature-requests
-->
## 🚀 Feature
(A clear and concise description of what the feature is.)
### Have you read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#reporting-new-issues)?
(Write your answer here.)
### Has this been requested on [Canny](https://docusaurus.io/feature-requests)?
(Please post the Canny link, it is helpful to see how much interest there is for this feature)
## Motivation
(Please outline the motivation for the proposal and why it should be implemented. Has this been requested by a lot of users?)
## API Design
(Please describe how Docusaurus users will enable and configure this feature, and what it will look like)
<!--
Please explain in an exhaustive way what are the config/plugin options and their respective effects.
For visual elements, please send us some screenshots/mockups of what it should look like. You can use https://excalidraw.com to create simple mockups.
-->
<!--
What happens if you skip this step? This issue may be closed without any in-depth discussion.
Your feature request is just an idea for now, please use Canny for that: https://docusaurus.io/feature-requests
-->
## Have you tried building it?
(Please explain how you tried to build the feature by yourself, and how successful it was)
<!--
Docusaurus 2 has a plugin system and theming support.
Quite often, this gives you the opportunity to build the feature you need by yourself.
We expect you to put your own work in this feature, particularly if it is not requested by a lot of users.
If we see it in action on your own site, it is easier to understand its value, and how it should work.
If you can't build it yourself for technical reasons, please explain why.
We are willing to help you, and eventually providing new APIs to make it possible.
-->
### Self-service
<!--
If you answered the question above as "no" because you feel like you could contribute directly to our repo, please check the box below by replacing the space with an X (- [X]).
This would tell us and other people looking for contributions that someone's working on it.
If you do check this box, please send a pull request within 7 days after a maintainer's approval so we can still delegate this to someone else.
Note that for feature issues, we still require you to fully fill out this form and reach consensus with the maintainers on API design before rushing to implement it, so that you don't waste your time.
-->
- [ ] I'd be willing to contribute this feature to Docusaurus myself.

72
.github/ISSUE_TEMPLATE/feature.yml vendored Normal file
View file

@ -0,0 +1,72 @@
name: 💅 Feature design / RFC
description: Submit a detailed feature request with a concrete proposal, including an exhaustive API / UI design
labels: [feature, needs triage]
body:
- type: markdown
attributes:
value: |
Important things:
- We expect you to submit a feature request including a real design (API / UI...), not just a basic idea.
- The design does not have to be perfect, we'll discuss it and fix it if needed.
- For a more "casual" feature request, consider using Canny instead: https://docusaurus.io/feature-requests.
- type: checkboxes
attributes:
label: Have you read the Contributing Guidelines on issues?
options:
- label: I have read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#reporting-new-issues).
required: true
- type: textarea
attributes:
label: Description
description: A clear and concise description of what the feature is.
validations:
required: true
- type: input
attributes:
label: Has this been requested on Canny?
description: Please post the [Canny](https://docusaurus.io/feature-requests) link, it is helpful to see how much interest there is for this feature.
- type: textarea
attributes:
label: Motivation
description: Please outline the motivation for the proposal and why it should be implemented. Has this been requested by a lot of users?
validations:
required: true
- type: textarea
attributes:
label: API design
description: |
Please describe how Docusaurus users will enable and configure this feature, and what it will look like.
Please explain in an exhaustive way what are the config/plugin options and their respective effects. For visual elements, please send us some screenshots/mockups of what it should look like. You can use https://excalidraw.com to create simple mockups.
> **What happens if you skip this step?** This issue may be closed without any in-depth discussion. Your feature request is just an idea for now, please use Canny for that: https://docusaurus.io/feature-requests.
- type: textarea
attributes:
label: Have you tried building it?
description: |
Please explain how you tried to build the feature by yourself, and how successful it was.
Docusaurus 2 has a plugin system and theming support. Quite often, this gives you the opportunity to build the feature you need by yourself.
We expect you to put your own work in this feature, particularly if it is not requested by a lot of users. If we see it in action on your own site, it is easier to understand its value, and how it should work.
If you can't build it yourself for technical reasons, please explain why. We are willing to help you, and eventually providing new APIs to make it possible.
> **What happens if you skip this step?** This issue may be closed without any in-depth discussion. Your feature request is just an idea for now, please use Canny for that: https://docusaurus.io/feature-requests.
- type: checkboxes
attributes:
label: Self-service
description: |
If you answered the question above as "no" because you feel like you could contribute directly to our repo, please check the box below. This would tell us and other people looking for contributions that someone's working on it.
If you do check this box, please send a pull request within 7 days after a maintainer's approval so we can still delegate this to someone else.
Note that for feature issues, we still require you to fully fill out this form and reach consensus with the maintainers on API design before rushing to implement it, so that you don't waste your time.
options:
- label: I'd be willing to contribute this feature to Docusaurus myself.

38
.github/ISSUE_TEMPLATE/proposal.md vendored
View file

@ -1,38 +0,0 @@
---
name: 💥 Proposal
about: Propose a non-trivial change to Docusaurus
labels: 'proposal, needs triage'
---
<!--
Common reasons for proposals include:
- Altering the infrastructure (e.g. swapping Webpack out with other bundlers);
- Bumping a critical dependency's major version;
- A significant improvement to a CLI command;
- Significant refactor;
- ...
This is not for feature requests. If this involves new APIs or new behaviors, consider requesting the feature on https://docusaurus.io/feature-requests instead.
We give you maximum freedom to write an elaborated proposal illustrating why you think the change is beneficial for us, and what steps we should take to turn this into reality.
You should not use this to ditch the feature request or bug template; such action could make us identify the issue wrongly and close it without doing anything.
-->
## 💥 Proposal
(A clear and concise description of what the proposal is.)
### Have you read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/master/CONTRIBUTING.md#reporting-new-issues)?
(Write your answer here.)
### Self-service
<!--
If you feel like you could contribute to this issue, please check the box below by replacing the space with an X (- [X]).
This would tell us and other people looking for contributions that someone's working on it.
If you do check this box, please send a pull request within 7 days after a maintainer's approval so we can still delegate this to someone else.
Proposals usually involve significant code changes, so please reach consensus with the maintainers before rushing to implement it. This ensures that you don't waste your time and we don't waste ours reading the large diffs.
-->
- [ ] I'd be willing to do some initial work on this proposal myself.

45
.github/ISSUE_TEMPLATE/proposal.yml vendored Normal file
View file

@ -0,0 +1,45 @@
name: 💥 Proposal
description: Propose a non-trivial change to Docusaurus
labels: [proposal, needs triage]
body:
- type: markdown
attributes:
value: |
Common reasons for proposals include:
- Altering the infrastructure (e.g. swapping Webpack out with other bundlers);
- Bumping a critical dependency's major version;
- A significant improvement to a CLI command;
- Significant refactor;
- ...
This is not for feature requests. If this involves new APIs or new behaviors, consider requesting the feature on https://docusaurus.io/feature-requests instead.
We give you maximum freedom to write an elaborated proposal illustrating why you think the change is beneficial for us, and what steps we should take to turn this into reality.
You should not use this to ditch the feature request or bug template; such action could make us identify the issue wrongly and close it without doing anything.
- type: checkboxes
attributes:
label: Have you read the Contributing Guidelines on issues?
options:
- label: I have read the [Contributing Guidelines on issues](https://github.com/facebook/docusaurus/blob/main/CONTRIBUTING.md#reporting-new-issues).
required: true
- type: textarea
attributes:
label: Motivation
description: A clear and concise description of what the proposal is.
validations:
required: true
- type: checkboxes
attributes:
label: Self-service
description: |
If you feel like you could contribute to this issue, please check the box below. This would tell us and other people looking for contributions that someone's working on it.
If you do check this box, please send a pull request within 7 days after a maintainer's approval so we can still delegate this to someone else.
Proposals usually involve significant code changes, so please reach consensus with the maintainers before rushing to implement it. This ensures that you don't waste your time and we don't waste ours reading the large diffs.
options:
- label: I'd be willing to do some initial work on this proposal myself.