CONTRIBUTING.md

Contributing

Environment setup

Use devbox to set up a development environment. Refer to the available scripts to see what's possible. Generally, even when running in a devbox shell, poetry run is necessary:

• devbox sets up what used to be system-wide packages (Python, poetry, ...) deterministically and automatically
• within the devbox virtual environment, we still manage and use a Python virtual environment through poetry run

That way, we get the normal Python package management for normal Python packages (ruff, black, pytest, ...), and devbox for the overarching rest.

Lastly, for bonus points, set up pre-commit hooks:

devbox run install-hooks

Creating components

Templates

To create a new template, inherit from Template and simply fulfills its interface: It needs a __rich_console__ method yielding all elements that will eventually make up the output document. That's it! The implementation is entirely up to you. You can use tables, panels, columns and most else rich has on offer.

mypy checks (make typecheck) will help getting the implementation right. However, note that this method cannot (currently) check whether all sections were implemented: for example, Volunteering could simply have been forgotten, but the code would run all checks would pass. Further, lots of manual and visual testing will be necessary.

Translations

Simply add your translation here.

Themes

Simply add your theme here.