From 5206663ee30efac7cdc6cc1d9b04692dc304efb6 Mon Sep 17 00:00:00 2001 From: Florent Date: Fri, 2 Aug 2024 17:33:58 +0200 Subject: [PATCH] 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 --- .github/ISSUE_TEMPLATE/00-bug-issue.yml | 52 +++++++++++++++++++ .../ISSUE_TEMPLATE/10-installation-issue.yml | 33 ++++++++++++ .github/ISSUE_TEMPLATE/20-feature-request.yml | 23 ++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++ .github/PULL_REQUEST_TEMPLATE.md | 27 ++++++++++ 5 files changed, 143 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/00-bug-issue.yml create mode 100644 .github/ISSUE_TEMPLATE/10-installation-issue.yml create mode 100644 .github/ISSUE_TEMPLATE/20-feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/00-bug-issue.yml b/.github/ISSUE_TEMPLATE/00-bug-issue.yml new file mode 100644 index 00000000..d2d861ab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/00-bug-issue.yml @@ -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: diff --git a/.github/ISSUE_TEMPLATE/10-installation-issue.yml b/.github/ISSUE_TEMPLATE/10-installation-issue.yml new file mode 100644 index 00000000..1be89dab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/10-installation-issue.yml @@ -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): diff --git a/.github/ISSUE_TEMPLATE/20-feature-request.yml b/.github/ISSUE_TEMPLATE/20-feature-request.yml new file mode 100644 index 00000000..66f2cb38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/20-feature-request.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..7129ce0a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..03b65db5 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,27 @@ +## Context + + + + +## Proposed solution + + + +## Related issues + + + + + +## Has this been tested? + + + +- [ ] 👍 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 + +## Screenshots / Screencasts + +