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.

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 make on its own to see a list of common commands

make task	effect
clean	clean up
commands	show available commands (default)
lint	check code and project
render	convert to HTML
serve	serve generated HTML
stats	basic site statistics

If you are on macOS you may want to use Homebrew to install:
- fswatch
- pstree
- tree
- watch

Labels

Name	Description	Color
change	something different	#FBCA04
feature	new feature	#B60205
fix	something broken	#5319E7
good first issue	newcomers are always welcome	#D4C5F9
talk	question or discussion	#0E8A16
task	one-off task	#1D76DB

Please use Conventional Commits style for pull requests by using change:, feature:, fix:, or task: as the first word in the title of the commit message. You may also use publish: if the PR just rebuilds the HTML version of the lesson.

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.

Contributors

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.

Our thanks to:

Stefan Arentz
Julia Evans
Robert Kern
Matt Panaro
Jean-Marc Saffroy

Colophon

The colors in this theme are lightened versions of those used in classic Canadian postage stamps. The art in the title is by Danielle Navarro and used with her gracious permission.
The CSS files used to style code were obtained from highlight-css; legibility was checked using WebAIM WAVE.
Diagrams were created with the desktop version of draw.io.
The site is hosted on GitHub Pages.
Thanks to the authors of BeautifulSoup, html5validator, ruff, and all the other software used in this project. If we all give a little, we all get a lot.