How to Contribute

[astroDimitrios]

Guidance on contributing to lesson development.

Meetings

We have monthly co-working meetings that are announced via the Carpentries calendar and the Discussions on this repository.
Please join a meeting if you would like to contribute.

Lesson Development

• Refer to the Curriculum Outline
• Refer to the Carpentries Workbench docs for info on callouts etc.
• Please use a fork to contribute
• Any Fortran code should follow the agreed style (Met Office)
• New episodes should have the .md extension
• If you are adding new exercises or data please re-compress
  the exercises.tar.gz file. In the root dir of this repo:

tar czf episodes/data/exercises.tar.gz exercises/

• Where possible, especially for large changes, build the lesson website and deploy to GH Pages with action 01 from your feature branch. Place a link to this build in your PR.
• Put your text through the readability grade checker - somewhere around 9/10 is preferable.
• Run a MD linter on your work. This helps avoid trailing whitespace, spelling errors etc. Make sure there is a newline at the end of each file and spaces between lists, code blocks and other elements. We recommend mdlint or prettier.
• Keep the line length under 100 characters, under 80 if possible.