Skip to content

Commit

Permalink
add templates
Browse files Browse the repository at this point in the history
  • Loading branch information
DirkEilander committed Dec 22, 2023
1 parent 2e3b167 commit fb20ed4
Show file tree
Hide file tree
Showing 8 changed files with 174 additions and 5 deletions.
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
name: Bug Report
description: Report incorrect behavior in the pyFlwDir library
labels: [Bug, Needs refinement]

body:
- type: checkboxes
id: checks
attributes:
label: pyFlwDir 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 pyFlwDir.
required: true
- type: textarea
id: example
attributes:
description: >
Please provide a minimal, copy-pastable example or a link to a public repository that reproduces the behavior. If providing a copy pastable example,
you may assume your in a clean up to date version of pyFlwDir with a python enviroment active. In the case of a repository, ensure the repository
has a README.md which includes intructions to reproduce the behaviour.
label: Reproducible Example
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:
description: >
Please add any other context about the bug here
label: Additional context
validations:
required: false
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---

blank_issues_enabled: false
contact_links:
- name: Ask a question
url: https://github.com/Deltares/pyflwdir/discussions
about: Ask questions and discuss with other community members
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_improvement.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
name: Documentation Improvement
description: Report wrong or missing documentation
labels: [Documentation, Needs refinement, Examples]

body:
- type: checkboxes
attributes:
label: pyFlwDir version checks
options:
- label: >
I have checked that the issue still exists on the latest versions of the docs on `main` [here](https://github.com/Deltares/pyflwdir)
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
validations:
required: true
- type: textarea
id: location
attributes:
description: >
If the docs are wrong or unclear please provide the URL of the documentation in question
label: Location of the documentation
- type: textarea
id: problem
attributes:
description: >
Please provide a description of the documentation problem
label: Documentation problem
validations:
required: true
- type: textarea
id: suggested-fix
attributes:
description: >
Please explain your suggested fix and why it's better than the existing documentation
label: Suggested fix for documentation
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Feature Request
description: Suggest an idea/enhancement for pyFlwDir
labels: [Enhancement, Needs refinement]

body:
- type: dropdown
id: checks
attributes:
description: What kind of feature request is this?
label: Kind of request
options:
- Adding new functionality
- Changing existing functionality
- Removing existing functionality
- type: textarea
id: description
attributes:
description: >
Please provide a clear and concise description of the feature you're requesting
label: Enhancement Description
validations:
required: true
- type: textarea
id: use-case
attributes:
description: >
Please describe a situation in which this feature would be useful to you, with code or cli examples if possible
label: Use case
- type: textarea
id: context
attributes:
description: >
Please add any other context about the enhancement here
label: Additional Context
8 changes: 8 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
version: 2
# there is no conda support for dependabot so this is the closest analog
# since the conda deps are also built from pyproject.toml it should work well enough
updates:
- package-ecosystem: "pip"
directory: "/" # Location of package manifests
schedule:
interval: "weekly"
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 `main`
- [ ] Updated documentation if needed
- [ ] Updated CHANGELOG.rst if needed

## Additional Notes (optional)
Add any additional notes or information that may be helpful.
2 changes: 1 addition & 1 deletion .github/workflows/test_cov.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Tests
name: Tests Coverage

on:
push:
Expand Down
20 changes: 16 additions & 4 deletions pixi.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,29 @@ platforms = ["linux-64", "win-64"]

[tasks]
# dev environment
dev = { depends_on = [
dev-env = { depends_on = [
"dev-env-file",
"dev-create-mamba-env",
"dev-install-hydromt",
"dev-install-pyflwdir",
"dev-install-pre-commit",
] }
dev-env-file = "python make_env.py full -n pyflwdir-dev -o pyflwdir-dev.yml"
min-env-file = "python make_env.py min -n pyflwdir-min -o pyflwdir-min.yml"
dev-create-mamba-env = "mamba env remove -n pyflwdir-dev; mamba env create -f pyflwdir-dev.yml"
dev-install-hydromt = "mamba run -n pyflwdir-dev pip install -e ."
dev-install-pyflwdir = "mamba run -n pyflwdir-dev pip install -e ."
dev-install-pre-commit = "mamba run -n pyflwdir-dev pre-commit install"
# test env
test-env = { depends_on = [
"test-env-file",
"test-create-mamba-env",
"test-install-pyflwdir",
"test-install-pre-commit",
] }
test-env-file = "python make_env.py test -p 3.9 -n pyflwdir-test -o pyflwdir-test.yml"
test-create-mamba-env = "mamba env remove -n pyflwdir-test; mamba env create -f pyflwdir-test.yml"
test-install-pyflwdir = "mamba run -n pyflwdir-test pip install -e ."
test-install-pre-commit = "mamba run -n pyflwdir-test pre-commit install"

min-env-file = "python make_env.py min -n pyflwdir-min -o pyflwdir-min.yml"

# linting
lint = "pre-commit run --all"
Expand Down

0 comments on commit fb20ed4

Please sign in to comment.