Issues and PR templates (#1135)

Issues and PRs descriptions sometimes lacks of details we would like to have to better understand the motivations behind.

I propose here templates to guide the reporters towards good descriptions.

These templates are heavily inspired from the ones of the PeerTube project.

Fixes #1125

---------

Co-authored-by: CamilleLegeron <camille@telescoop.fr>
This commit is contained in:
Florent 2024-08-02 17:33:58 +02:00 committed by GitHub
parent c205f4cfb1
commit 5206663ee3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 143 additions and 0 deletions

52
.github/ISSUE_TEMPLATE/00-bug-issue.yml vendored Normal file
View File

@ -0,0 +1,52 @@
# Inspired by PeerTube templates:
# https://github.com/Chocobozzz/PeerTube/blob/3d4d49a23eae71f3ce62cbbd7d93f07336a106b7/.github/ISSUE_TEMPLATE/00-bug-issue.yml
name: 🐛 Bug Report
description: Use this template for reporting a bug
body:
- type: markdown
attributes:
value: |
Thanks for taking time to fill out this bug report!
Please search among past open/closed issues for a similar one beforehand:
- https://github.com/gristlabs/grist-core/issues?q=
- https://community.getgrist.com/
- type: textarea
attributes:
label: Describe the current behavior
- type: textarea
attributes:
label: Steps to reproduce
value: |
1.
2.
3.
- type: textarea
attributes:
label: Describe the expected behavior
- type: checkboxes
attributes:
label: Where have you encountered this bug?
options:
- label: On [docs.getgrist.com](https://docs.getgrist.com)
- label: On a self-hosted instance
validations:
required: true
- type: textarea
attributes:
label: Instance information (when self-hosting only)
description: In case you self-host, please share information above. You can discard any question you don't know the answer.
value: |
* Grist instance:
* Version:
* URL (if it's OK for you to share it):
* Installation mode: docker/kubernetes/...
* Architecture: single-worker/multi-workers
* Browser name, version and platforms on which you could reproduce the bug:
* Link to browser console log if relevant:
* Link to server log if relevant:

View File

@ -0,0 +1,33 @@
# Inspired by PeerTube templates:
# https://github.com/Chocobozzz/PeerTube/blob/master/.github/ISSUE_TEMPLATE/10-installation-issue.yml
name: 🛠️ Installation/Upgrade Issue
description: Use this template for installation/upgrade issues
body:
- type: markdown
attributes:
value: |
Please check first the official documentation for self-hosting: https://support.getgrist.com/self-managed/
- type: markdown
attributes:
value: |
Please search among past open/closed issues for a similar one beforehand:
- https://github.com/gristlabs/grist-core/issues?q=
- https://community.getgrist.com/
- type: textarea
attributes:
label: Describe the problem
- type: textarea
attributes:
label: Additional information
value: |
* Grist version:
* Grist instance URL:
* SSO solution used and its version (if relevant):
* S3 storage solution and its version (if relevant):
* Docker version (if relevant):
* NodeJS version (if relevant):
* Redis version (if relevant):
* PostgreSQL version (if relevant):

View File

@ -0,0 +1,23 @@
# Inspired by PeerTube templates:
# https://github.com/Chocobozzz/PeerTube/blob/master/.github/ISSUE_TEMPLATE/30-feature-request.yml
---
name: ✨ Feature Request
description: Use this template to ask for new features and suggest new ideas 💡
body:
- type: markdown
attributes:
value: |
Thanks for taking time to share your ideas!
Please search among past open/closed issues for a similar one beforehand:
- https://github.com/gristlabs/grist-core/issues?q=
- https://community.getgrist.com/
- type: textarea
attributes:
label: Describe the problem to be solved
description: Provide a clear and concise description of what the problem is
- type: textarea
attributes:
label: Describe the solution you would like
description: Provide a clear and concise description of what you want to happen

8
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: 🤷💻🤦 Question/Forum
url: https://community.getgrist.com/
about: You can ask and answer other questions here
- name: 💬 Discord
url: https://discord.com/invite/MYKpYQ3fbP
about: Chat with us via Discord for quick Q/A here and sharing tips

27
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,27 @@
## Context
<!-- Please include a summary of the change, with motivation and context -->
<!-- Bonus: if you are comfortable writing one, please insert a user-story https://en.wikipedia.org/wiki/User_story#Common_templates -->
## Proposed solution
<!-- Describe here how you address the issue -->
## Related issues
<!-- If suggesting a new feature or change, please discuss it in an issue first -->
<!-- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!-- If this does not solve entirely the issue, make also a checklist of what is done or not: -->
## Has this been tested?
<!-- Put an `x` in the box that applies: -->
- [ ] 👍 yes, I added tests to the test suite
- [ ] 💭 no, because this PR is a draft and still needs work
- [ ] 🙅 no, because this is not relevant here
- [ ] 🙋 no, because I need help <!-- Detail how we can help you -->
## Screenshots / Screencasts
<!-- delete if not relevant -->