Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

37 lines (22 loc) · 1.5 KB

How to contribute to enzax

All contributions are very welcome!

Make sure to read the code of conduct and follow its recommendations.

If you have a specific suggestion for how enzax could be improved, or if you find a bug then please file an issue or submit a pull request.

Alternatively, if you have any more general thoughts or questions, please post them in the discussions page.

If you would like to contribute code changes, just follow the normal GitHub workflow: make a local branch with the changes then create a pull request.

Developing enzax locally

To develop enzax locally you will probably need to install it with development dependencies. Here is how to do so:

$ pip install enzax'[dev]'

You can see what these dependencies are by checking the [tool.pdm.dev-dependencies] table in enzax's pyproject.toml file.

Releasing new versions of enzax

To release a new version of enzax, edit the field version in pyproject.toml, e.g. to 0.2.1 then make a pull request with this change.

Once the changes are merged into the origin/main branch, add a tag whose name begins with v, followed by the new version number to your local main branch, for example like this:

$ git tag v0.2.1

Now push the new tag to GitHub:

$ git push origin "v0.2.1"