Contributing¶

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

You can contribute in many ways:

Types of Contributions¶

If you are reporting a bug, please include:

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

mzx could always use more documentation, whether in the Sphinx docs under docs/, in docstrings, or in README.rst.

The best way to send feedback is to file an issue at https://github.com/mass-matrix/mzx/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

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

Clone your fork locally:

$ git clone https://github.com/your_name_here/mzx.git

Create a virtual environment and install dependencies. With uv (used by the Makefile):

$ cd mzx/
$ make setup
$ source .venv/bin/activate
$ make install

Or with plain pip:

$ python -m venv .venv
$ source .venv/bin/activate
$ pip install -r requirements.txt
$ pip install -e .

Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
Before opening a PR, run the checks the project uses:
```
$ make lint
$ make mypy
$ make test
```

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

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests when practical.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst if it is user-facing.

To run a subset of tests:

$ python -m pytest tests/test_vendor.py -v