Contributing#

Thank you for considering improving Empulse, any contribution is much welcome!

Asking questions#

If you have any question about Empulse, if you are seeking for help, or if you would like to suggest a new feature, you are encouraged to open a new issue so we can discuss it. Bringing new ideas and pointing out elements needing clarification allows to make this library always better!

Reporting a bug#

If you encountered an unexpected behavior using Empulse, please open a new issue and describe the problem you have spotted. Be as specific as possible in the description of the trouble so we can easily analyse it and quickly fix it.

An ideal bug report includes:

  • The Python version you are using

  • The empulse version you are using (you can find it with print(empulse.__version__))

  • Your operating system name and version (Linux, MacOS, Windows)

  • Your development environment and local setup (IDE, Terminal, project context, any relevant information that could be useful)

  • Some minimal reproducible example

Implementing changes#

If you are willing to enhance Empulse by implementing non-trivial changes, please open a new issue first to keep a reference about why such modifications are made (and potentially avoid unneeded work).

Prefer using a relatively recent Python version as some dependencies required for development may have dropped support for oldest Python versions. Then, the workflow would look as follows:

  1. Fork the empulse project from GitHub.

  2. Clone the repository locally:

    $ git clone git@github.com:your_name_here/empulse.git
$ cd empulse

  3. Activate your virtual environment:

    $ python -m venv env
$ source env/bin/activate

  4. Install uv:

    $ pip install uv

  5. Install Empulse with development dependencies:

    $ uv sync

  6. Install pre-commit hooks that will check your commits:

    $ pre-commit install --install-hooks

  7. Create a new branch from main:

    $ git checkout main
$ git branch fix_bug
$ git checkout fix_bug

  8. Implement the modifications wished. During the process of development, honor PEP 8 as much as possible.

  9. Add unit tests (don’t hesitate to be exhaustive!) and ensure none are failing using:

    $ uvx --with tox-uv tox -f tests

  1. Remember to update documentation if required.

  2. If your development modifies Empulse behavior, update the CHANGELOG.rst file with what you improved.

  3. add and commit your changes, then push your local project:

    $ git add .
$ git commit -m 'Add succinct explanation of what changed'
$ git push origin fix_bug

  4. If previous step failed due to the pre-commit hooks, fix reported errors and try again.

  5. Finally, open a pull request before getting it merged!