DEVELOPING.md

Developing indifferent

indifferent is intentionally unopinionated so that it remains easy to use and maintain.

Local development

VS Code is strongly recommended. Install the recommended extensions and use the default Extension settings defined in the repo.

Install a development version of indifferent

The best way to make changes to indifferent is to create a simple Python project that invokes your development version in situ.

1. Create a new empty Python project and a virtual environment

2. Install the module using the editable flag, specifying the location of indifferent:

   python3 -m pip -e path/to/indifferent

3. Make your changes

Use pytest early and often

Two rules:

1. All functionality must be in a function
2. All functions must have tests

Create a new test file in tests/ for each function you add.