CONTRIBUTING.md

Contributing

Thanks you for your interest in contributing to the development of pycashier!

See below for getting started editing the pycashier source or documentation. Please submit an issue with a detailed bug report or feature request prior to opening any pull requests.

Setup Environment

Note

Most important development tasks are covered by recipes within the Makefile. See make help for more info.

The development for pycashier is managed by pixi. You can use the included Makefile to setup pixi envs and pre-commit.

make env
pixi shell -e dev

Or directly calling the commands invoked my make env:

pixi install -e dev
pixi run -e dev pre-commit install
pixi shell -e dev

Note

There is a hidden pycashier command to check for runtime dependencies: pycashier checks.

Editing Source

Running Tests

The current test suite focuses on integration tests of the main CLI using known inputs/output files.

After making any changes to the source you can run tests with pytest or using the below command:

Any additional functionality or feature should be covered by an integration test using known inputs/outputs.

make test

Documentation

The documentation is written in markdown and built using sphinx. If you setup your environment as described above then you can live preview changes by running the following:

make docs-serve