Skip to content

Commit

Permalink
Add CONTRIBUTING.md link to docs, update issue template, add discussi…
Browse files Browse the repository at this point in the history
…on template
  • Loading branch information
VeckoTheGecko committed Jul 31, 2024
1 parent cacf91c commit 65825be
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 4 deletions.
22 changes: 22 additions & 0 deletions .github/DISCUSSION_TEMPLATE/q-a.yml
Original file line number Diff line number Diff line change
@@ -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
13 changes: 11 additions & 2 deletions .github/ISSUE_TEMPLATE/02_bug.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
6 changes: 4 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
See https://docs.oceanparcels.org/en/latest/contributing.html

0 comments on commit 65825be

Please sign in to comment.