Contributing
The usual process to make a contribution is to:
- Check for existing related issues
- Fork the repository and create a new branch
- Make your changes
- Make sure formatting, linting and tests passes.
- Add tests if possible to cover the lines you added.
- Commit, and send a Pull Request.
Fork the repository
So that you have your own copy.
Clone the repository
git clone git@github.com:your-username/una.git
cd una
git checkout -b add-my-contribution
Setup uv
Install it if needed (full instructions here):
curl -LsSf https://astral.sh/uv/install.sh | sh
Then sync your local environment:
uv sync
Run all code quality checks
make fmt
make lint
make check
make test
# or
make all
Open a PR
Push your changes to your branch on your fork, then open a PR against the main repository.