school-brainhack / school-brainhack/school-brainhack.github.io
Maintenance of [testing] module
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 42
- Forks
- 185
- PR merge metrics
- No merged PRs in 30d
Description
Module to maintain
Website: https://school.brainhackmtl.org/modules/testing/
Code: https://github.com/school-brainhack/school-brainhack.github.io/tree/main/content/en/modules/testing
Work to be done
To ease maintenance, I would suggest that we move towards existing materials for teaching software testing and continuous integration. In particular, I believe that "Section 2 : Ensuring Correctness of Software at Scale" of the Carpentries Incubator: Intermediate Research Software Development course matches well with what is included in the current material.
It would also provide an opportunity for us to contribute upstream to Carpentries lesson development on their repo.
cc @htwangtw, who taught this material in this year's Montreal BHS.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing materials in content/en/modules/testing and the published testing module at school.brainhackmtl.org/modules/testing/. Compare them with Section 2 of the Carpentries Incubator's python-intermediate-development course, then identify what should be replaced or adapted and what upstream contribution may be needed. Done means the module has a clear maintenance plan or updated content aligned with the selected Carpentries materials.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- ci-cd, documentation, testing
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100