Contributing

Contributions are very welcome; please contact us by email or by filing an issue in our repository. All contributors must abide by our Code of Conduct.

Contributors

Juanan Pereira is a lecturer in Computer Science at the University of the Basque Country (UPV/EHU), where he researches and tries to integrate open source software, software engineering, and LLMs in education.

Greg Wilson is a programmer, author, and educator based in Toronto. He was the co-founder and first Executive Director of Software Carpentry and received ACM SIGSOFT's Influential Educator Award in 2020.

Setup and Operation

• Install uv
• Create a virtual environment by running uv venv in the root directory
• Activate it by running source .venv/bin/activate in your shell
• Install dependencies by running uv pip install -r pyproject.toml
• This project uses mccole to generate HTML and check the project's structure
• Run task --list to see a list of common commands

FAQ

Do you need any help?

Yes—please see the issues in our repository.

What sort of feedback would be useful?

Everything is welcome, from pointing out mistakes in the code to suggestions for better explanations.

Can I add a new section?

Absolutely, but please reach out before doing so.

Why is this material free to read?

Because if we all give a little, we all get a lot.