Contribute to Matfree
Contributions are absolutely welcome!
Issues:
Most contributions start with an issue. Please don't hesitate to create issues in which you ask for features, give feedback on performances, or simply want to reach out.
Pull requests:
To make a pull request, proceed as follows:
- Fork the repository.
- Install all dependencies with
pip install .[full]
orpip install -e .[full]
. - Make your changes.
- From the root of the project, run the tests via
make test
, and check outmake format
andmake lint
as well. Use the pre-commit hook if you like.
When making a pull request, keep in mind the following (rough) guidelines:
- Most PRs resolve an issue.
- Most PRs contain a single commit. Here is how we can write better commit messages.
- Most enhancements (e.g. new features) are covered by tests.