Contributing

This document briefly describes how to contribute to cascade-config.

Before you begin

If you have an idea for a feature, use case to add or an approach for a bugfix, you are welcome to communicate it with the community by creating an issue in GitHub issues.

How to contribute

• Fork cascade-config on GitHub to make your changes.

• Commit and push your changes to your fork.

• Open a pull request with these changes. You pull request message ideally should include:

  • A description of why the changes should be made.

  • A description of the implementation of the changes.

  • A description of how to test the changes.

• The pull request should pass all the continuous integration tests which are automatically run by GitHub Actions.

Development setup

1. Setup Python 3 and Flit

2. Clone the cascade-config repository and run flit install to setup an editable version of cascade-config.

Development workflow

• When a new version is ready to be published:

  1. Change the __version__ in cascade_config.py following semantic versioning.

  2. Update the documentation (README.md and docs/source/usage.rst) if required.

  3. Update the changelog (if not already done) in CHANGELOG.md according to Keep a Changelog.

  4. Merge all final changes into the main branch.

  5. Create a new GitHub release.

• When a new GitHub release is created, the publish GitHub Action is triggered, building the Python package is build and publishes it to PyPI.