Appendix C — 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.
C.1 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.
Thanks to:
- Daniel Standage for helping create the original workshop
- Karl Fogel for Producing Open Source Software
- Damien Irving, Kate Hertweck, Luke Johnston, Joel Ostblom, and Charlotte Wickham for Research Software Engineering with Python
C.2 Setup and Operation
- Install Quarto to build the site.
- Run
makeon its own to see a list of common commands
| make task | effect |
|---|---|
| site | render HTML pages |
| serve | preview the site locally |
| check | check structure, spelling, and links |
| bib | validate the bibliography |
| clean | remove generated and cache files |
C.3 Structure
- Lessons are in
slugdirectories (e.g.,intro/,health/)- Each lesson has an
index.qmdfile containing its content
- Each lesson has an
- Diagrams should be SVG files created with draw.io
bibliography/references.bibholds the bibliography in BibTeX format- Cite entries with
[@Key](e.g.,[@Aurora2019])
- Cite entries with
glossary/index.qmdholds the glossary as a definition list- Reference terms with
"display text"
- Reference terms with
_quarto.ymlconfigures the book and chapter order
C.4 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.