Contributing#

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Report Bugs#

If you are reporting a bug, please include:

Ready to contribute? Here’s how to set up ddlpy for local development.

Clone your fork locally:

$ git clone git@github.com:your_name_here/ddlpy.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv ddlpy
$ cd ddlpy/
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 ddlpy tests
$ python setup.py test or py.test
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

To run all the tests:

$ pytest

To run a subset of tests:

$ pytest tests/test_ddlpy.py

To generate the documentation:

$ sphinx-build docs docs/_build

make sure the main branch is up to date (check pytest warnings, important issues solved, all pullrequests and branches closed)
create and checkout branch for release
bump the versionnumber with bumpversion minor
update heading (including date) in HISTORY.rst
run testbank
local check with: python -m build and twine check dist/*
commit+push to branch and merge PR
copy the ddlpy version from pyproject.toml (e.g. 0.3.0)
create a new release at Deltares/ddlpy
click choose a tag and type v+versionnumber (e.g. v0.3.0), click create new tag on publish
set the release title to the tagname (e.g. v0.3.0)
click Generate release notes and replace the What's Changed info by a tagged link to HISTORY.rst
if all is set, click Publish release
a release is created and published on PyPI by the github action
post-release: commit+push bumpversion patch and UNRELEASED header in HISTORY.rst to distinguish between release and dev version