From 65825be1182087ba49496cfee755c6fe159f08cb Mon Sep 17 00:00:00 2001 From: Vecko Date: Tue, 30 Jul 2024 17:48:35 +0200 Subject: [PATCH] Add CONTRIBUTING.md link to docs, update issue template, add discussion template --- .github/DISCUSSION_TEMPLATE/q-a.yml | 22 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/02_bug.yaml | 13 +++++++++++-- .github/ISSUE_TEMPLATE/config.yml | 6 ++++-- CONTRIBUTING.md | 1 + 4 files changed, 38 insertions(+), 4 deletions(-) create mode 100644 .github/DISCUSSION_TEMPLATE/q-a.yml create mode 100644 CONTRIBUTING.md diff --git a/.github/DISCUSSION_TEMPLATE/q-a.yml b/.github/DISCUSSION_TEMPLATE/q-a.yml new file mode 100644 index 000000000..ea85fcb23 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/q-a.yml @@ -0,0 +1,22 @@ +body: + - type: textarea + id: improvements + attributes: + label: Question + description: "Type in the form below your question to the Parcels community. Make sure to detail any relevant context including what you have tried, as well as any relevant code or error messages." + value: | + ## Question + + + ## Supporting code/error messages + + ```python + # Paste your code within this block + ``` + + + ```text + # Paste your error message within this block + ``` + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/02_bug.yaml b/.github/ISSUE_TEMPLATE/02_bug.yaml index 698e8a250..74050b355 100644 --- a/.github/ISSUE_TEMPLATE/02_bug.yaml +++ b/.github/ISSUE_TEMPLATE/02_bug.yaml @@ -11,12 +11,21 @@ body: - type: "textarea" attributes: label: "Description" - description: "Please describe the bug" + description: "Please describe the bug." validations: required: true - type: "textarea" attributes: label: "Code sample" - description: "Please provide a code example where this bug is shows. A [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) makes it much easier for us developers to identify the cause of the bug. This also allows us to quickly determine whether the problem is with your code or with Parcels itself." + description: "If relevant, please provide a code example where this bug is shown as well as any error message. A [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) is preffered as it makes it much easier for developers to identify the cause of the bug. This also allows them quickly determine whether the problem is with your code or with Parcels itself." + value: | + ```python + # Paste your code within this block + ``` + + + ```text + # Paste your error message within this block + ``` validations: required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 06087e72a..d676aeb84 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,7 @@ contact_links: - name: 🙏 Parcels use question, help, or support + url: https://github.com/OceanParcels/parcels/discussions/new?category=q-a + about: Have a question about Parcels? Or do you need troubleshooting for a specific usecase? Then start a Q&A Discussion thread instead, and we'll be happy to help. + - name: 💬 Other Parcels discussion url: https://github.com/OceanParcels/parcels/discussions - about: > - Have a question about Parcels? Or do you need troubleshooting for a specific usecase? Then start a Discussion thread instead, and we'll be happy to help. + about: For general discussion about Parcels, or to share your work with the community, please use the Discussions tab. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..a95a61d64 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1 @@ +See https://docs.oceanparcels.org/en/latest/contributing.html