PlasmaPyand contribute! Digging in after a long stream of recommendations leading me here.
I'm going to be giving a tutorial on Monday on writing clean code. It's being organized through the library at my institution, but I asked and it's okay for people from elsewhere to join in.
Writing Clean Scientific Software
Monday, March 15th, 2-3pm EDT (18 UTC)
Presented by Nick Murphy
The Zoom link (and an email reminder) will be emailed to registrants after signing up.
Software is vital to modern science. It's hard to think of an astronomical research project that does not make use of software in some fundamental way. But despite how foundational software is to our research, graduate programs in science have tended to lack coursework in research software engineering. Because of this, scientists often end up having to write code without any formal training. This tutorial will cover best practices for writing research software that is readable, maintainable, and thus easier to change. Some of the topics will include choosing meaningful variable names, writing clean functions, separating high-level big picture code from low-level implementation details, and writing clean tests. This tutorial will encourage us to think of code as communication.
CHANGELOG.rstwith a link to the change log page on RTD? You'd probably want to also make CHANGELOG a markdown file.