Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 813 Bytes

DEVELOPERS.md

File metadata and controls

55 lines (36 loc) · 813 Bytes

Notes for developers

System requirements

just

just is a handy way to save and run project-specific commands. It's unrelated to the package with the same name on PyPI.

# macOS
brew install just

# Linux
# Install from https://github.com/casey/just/releases

# Show all available commands
just # Shortcut for just --list

Development

Set up a local development environment with

just devenv

and create a new branch. Then, iteratively:

  • Make changes to the code

  • Run the tests with

    just test

  • Check the code for issues with

    just check

  • Fix any issues with

    just fix

  • Commit the changes

Finally, push the branch to GitHub and open a pull request against the main branch.