mirror of
https://github.com/suitenumerique/docs
synced 2026-04-21 13:37:20 +00:00
📝(issue templates) switch to forms
so it is easier to file issues Signed-off-by: virgile-deville <virgile.deville@beta.gouv.fr>
This commit is contained in:
parent
e59d8a4631
commit
5ccc7b2469
6 changed files with 170 additions and 73 deletions
32
.github/ISSUE_TEMPLATE/Bug_report.md
vendored
32
.github/ISSUE_TEMPLATE/Bug_report.md
vendored
|
|
@ -1,32 +0,0 @@
|
|||
---
|
||||
name: 🐛 Bug Report
|
||||
about: If something is not working as expected 🤔.
|
||||
labels: ["bug", "triage"]
|
||||
---
|
||||
|
||||
## Bug Report
|
||||
|
||||
**Before you file your issue**
|
||||
- Check the other [issues](https://github.com/suitenumerique/docs/issues) before filing your own
|
||||
- If your report is related to the ([BlockNote](https://github.com/TypeCellOS/BlockNote)) text editor, [file it on their repo](https://github.com/TypeCellOS/BlockNote/issues). If you're not sure whether your issue is with BlockNote or Docs, file it on our repo: if we support it, we'll backport it upstream ourselves 😊, otherwise we'll ask you to do so.
|
||||
|
||||
**Problematic behavior**
|
||||
A clear and concise description of the behavior.
|
||||
|
||||
**Expected behavior/code**
|
||||
A clear and concise description of what you expected to happen (or code).
|
||||
|
||||
**Steps to Reproduce**
|
||||
1. Do this...
|
||||
2. Then this...
|
||||
3. And then the bug happens!
|
||||
|
||||
**Environment**
|
||||
- Docs version:
|
||||
- Instance url:
|
||||
|
||||
**Possible Solution**
|
||||
<!--- Only if you have suggestions on a fix for the bug -->
|
||||
|
||||
**Additional context/Screenshots**
|
||||
Add any other context about the problem here. If applicable, add screenshots to help explain.
|
||||
23
.github/ISSUE_TEMPLATE/Feature_request.md
vendored
23
.github/ISSUE_TEMPLATE/Feature_request.md
vendored
|
|
@ -1,23 +0,0 @@
|
|||
---
|
||||
name: ✨ Feature Request
|
||||
about: I have a suggestion (and may want to build it 💪)!
|
||||
labels: ["feature", "triage"]
|
||||
---
|
||||
|
||||
## Feature Request
|
||||
|
||||
**Is your feature request related to a problem or unsupported use case? Please describe.**
|
||||
A clear and concise description of what the problem is. For example: I need to do some task and I have an issue...
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen. Add any considered drawbacks.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Discovery, Documentation, Adoption, Migration Strategy**
|
||||
If you can, explain how users will be able to use this and possibly write out some documentation (if applicable).
|
||||
Maybe add a screenshot or design?
|
||||
|
||||
**Do you want to work on it through a Pull Request?**
|
||||
<!-- Make sure to coordinate with us before you spend too much time working on an implementation! -->
|
||||
18
.github/ISSUE_TEMPLATE/Support_question.md
vendored
18
.github/ISSUE_TEMPLATE/Support_question.md
vendored
|
|
@ -1,18 +0,0 @@
|
|||
---
|
||||
name: 🤗 Support Question
|
||||
about: If you have a question 💬, or something was not clear from the docs!
|
||||
labels: ["support", "triage"]
|
||||
---
|
||||
## Support request
|
||||
**Checks before filing**
|
||||
Please make sure you have read our [main Readme](https://github.com/suitenumerique/docs).
|
||||
|
||||
Also make sure it was not already answered in [an open or close issue](https://github.com/suitenumerique/docs/issues?q=is%3Aissue%20state%3Aopen%20label%3Asupport).
|
||||
|
||||
If your question was not covered, and you feel like it should be, fire away! We'd love to improve our docs! 👌
|
||||
|
||||
**Topic**
|
||||
What's the general area of your question: for example, docker setup, database schema, search functionality,...
|
||||
|
||||
**Question**
|
||||
Try to be as specific as possible so we can help you as best we can. Please be patient 🙏
|
||||
94
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
94
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
|
|
@ -0,0 +1,94 @@
|
|||
name: Bug Report
|
||||
description: File a bug report.
|
||||
title: "🐛(Bug) "
|
||||
labels: ["triage"]
|
||||
projects: ["suitenumerique/2"]
|
||||
assignees:
|
||||
- virgile-dev
|
||||
type: bug
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this bug report!
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Before filing a new issue, please do a quick search in the issues / prs list to avoid duplicates.
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
We use [BlockNote](https://www.blocknotejs.org/) for the text editing features of Docs. If you find an issue with the editor and are able to reproduce it on their [demo](https://www.blocknotejs.org/demo) it's best to report it directly on the [BlockNote repository](https://github.com/TypeCellOS/BlockNote/issues).
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: Also tell us, what did you expect to happen?
|
||||
placeholder: Tell us what you see!
|
||||
value: "A bug happened!"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: solution
|
||||
attributes:
|
||||
label: Possible solution?
|
||||
description: If you have suggestions on a fix for the bug
|
||||
placeholder: Try this, or that ...
|
||||
value: "I have a solution!"
|
||||
validations:
|
||||
required: false
|
||||
- type: textarea
|
||||
id: version
|
||||
attributes:
|
||||
label: Version
|
||||
description: What version of our software are you running?
|
||||
value: "4.x.x"
|
||||
validations:
|
||||
required: false
|
||||
- type: input
|
||||
id: instance
|
||||
attributes:
|
||||
label: Instance url
|
||||
description: What's your instance url?
|
||||
value: "docs.example.org"
|
||||
validations:
|
||||
required: false
|
||||
- type: dropdown
|
||||
id: browsers
|
||||
attributes:
|
||||
label: What browsers are you seeing the problem on?
|
||||
multiple: true
|
||||
options:
|
||||
- Firefox
|
||||
- Chrome
|
||||
- Safari
|
||||
- Microsoft Edge
|
||||
- type: textarea
|
||||
id: logs
|
||||
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: upload
|
||||
id: screenshots
|
||||
attributes:
|
||||
label: Upload screenshots
|
||||
description: If applicable, add screenshots to help explain your problem.
|
||||
validations:
|
||||
required: false
|
||||
- type: input
|
||||
id: contact
|
||||
attributes:
|
||||
label: Contact Details
|
||||
description: How can we get in touch with you if we need more info?
|
||||
placeholder: ex. email@example.com
|
||||
validations:
|
||||
required: false
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: Code of Conduct
|
||||
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
|
||||
options:
|
||||
- label: I agree to follow this project's Code of Conduct
|
||||
required: true
|
||||
6
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
6
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
blank_issues_enabled: false
|
||||
|
||||
contact_links:
|
||||
- name: Support question
|
||||
url: https://matrix.to/#/#docs-official:matrix.org
|
||||
about: If you have a question, or something was not clear from the docs, reach out for help on our Matrix Channel or email us at docs.team@la-suite.eu
|
||||
70
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
70
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
name: Feature request
|
||||
description: Suggest an new feature or an enhancement.
|
||||
title: "✨(feature) "
|
||||
labels: ["triage"]
|
||||
projects: ["suitenumerique/2"]
|
||||
assignees:
|
||||
- virgile-dev
|
||||
type: feature
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to suggest a feature!
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Before filing a new issue, please do a quick search in the issues / prs list to avoid duplicates.
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
We use [BlockNote](https://www.blocknotejs.org/) for the text editing features of Docs. It's best to suggest features on the text editor directly on the [BlockNote repository](https://github.com/TypeCellOS/BlockNote/discussions/categories/ideas-enhancements).
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: What problem do you want to fix?
|
||||
description: A concise description of what the problem is.
|
||||
placeholder:
|
||||
value: "My problem is"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: solution
|
||||
attributes:
|
||||
label: Possible solution?
|
||||
description: A concise description of what you need to fix your problem.
|
||||
placeholder: I
|
||||
value: "I need this feature"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: alternative
|
||||
attributes:
|
||||
label: Do you have an alternative?
|
||||
description: If you found a workaround or have thought of another way to solve your problem.
|
||||
value: "My workaround is ..."
|
||||
validations:
|
||||
required: false
|
||||
- type: upload
|
||||
id: screenshots
|
||||
attributes:
|
||||
label: Upload
|
||||
description: If applicable, add screenshots to help explain your problem.
|
||||
validations:
|
||||
required: false
|
||||
- type: input
|
||||
id: contact
|
||||
attributes:
|
||||
label: Contact Details
|
||||
description: How can we get in touch with you if we need more info?
|
||||
placeholder: ex. email@example.com
|
||||
validations:
|
||||
required: false
|
||||
- type: checkboxes
|
||||
id: terms
|
||||
attributes:
|
||||
label: Code of Conduct
|
||||
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
|
||||
options:
|
||||
- label: I agree to follow this project's Code of Conduct
|
||||
required: true
|
||||
Loading…
Reference in a new issue