Skip to content

Commit

Permalink
Add templates
Browse files Browse the repository at this point in the history
  • Loading branch information
dalmijn committed Mar 10, 2024
1 parent 8617e48 commit 91b174e
Show file tree
Hide file tree
Showing 5 changed files with 152 additions and 0 deletions.
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bugs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Bugs
description: Broken elements within WFS20
# title: "BUG: "
labels: [bug]

body:
- type: checkboxes
id: checks
attributes:
label: WFS20 version checks
options:
- label: >
I have checked that this issue has not already been reported.
required: true
- label: >
I have checked that this bug exists on the latest version of WFS20.
required: true
- type: textarea
id: example
attributes:
label: Reproducible Example
description: >
Please provide a minimal, copy-pastable example to reproduce the behavior:
validations:
required: true
- type: textarea
id: current-behaviour
attributes:
description: >
Please provide a description of the incorrect behaviour shown in the reproducible example
label: Current behaviour
validations:
required: true
- type: textarea
id: expected-behaviour
attributes:
description: >
Please provide a description of what you think the behaviour should be
label: Desired behaviour
validations:
required: true
- type: textarea
id: Additional
attributes:
label: Additional Context
description: >
Please add any other context about the bug here:
validations:
required: false
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/Deltares/WFS20/discussions
about: Ask questions and discuss with other community members
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Documentation
description: Missing or bad documentation.
# title: "Docs: "
labels: [documentation]

body:
- type: checkboxes
attributes:
label: WFS20 version checks
options:
- label: >
I have checked that the issue still exists on the latest versions of the docs
on `master` [here](https://github.com/dalmijn/WFS20)
required: true
- type: dropdown
id: kind
attributes:
description: What kind of documentation issue is this?
label: Kind of issue
options:
- Docs are wrong
- Docs are unclear
- Docs are missing
- type: textarea
id: location
attributes:
label: Location of the documentation
description: >
Please provide the URL of the documentation:
validations:
required: true
- type: textarea
id: problem
attributes:
label: Documentation problem
description: >
Please provide a description of the documentation problem:
validations:
required: true
- type: textarea
id: suggested-fix
attributes:
label: Suggested fix for documentation
description: >
Please explain your suggested fix and why it's better than the existing documentation:
validations:
required: false
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature Request
description: Propose an improvement for WFS20
# title: "Improvement: "
labels: [enhancement]

body:
- type: dropdown
id: checks
attributes:
description: What kind of feature request is this?
label: Feature type
options:
- Adding new functionality
- Changing existing functionality
- Removing existing functionality
- type: textarea
id: description
attributes:
label: Improvement Description
description: >
Please provide a clear and concise description of what your proposed improvement is:
validations:
required: true
- type: textarea
id: feature
attributes:
label: Implementation Description
description: >
Please describe how this would be implemented:
validations:
required: false
- type: textarea
id: context
attributes:
label: Additional Context
description: >
Please add any other context about the improvement here:
14 changes: 14 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Issue addressed
Fixes #<issue number>

## Explanation
Explain how you addressed the bug/feature request, what choices you made and why.

## Checklist
- [ ] Updated tests or added new tests
- [ ] Branch is up to date with `master`
- [ ] Tests & pre-commit hooks pass
- [ ] Updated documentation if needed

## Additional Notes (optional)
Add any additional notes or information that may be helpful.

0 comments on commit 91b174e

Please sign in to comment.