Guidelines for code review
@MitchellBlack is already working on this.
Since Oct 5, 2021.
Assessment
This issue has not been assessed yet.
Description
At some stage we may wish to develop guidelines around code review (e.g. the code associated with producing a particular analysis input or output may need to be reviewed before that input/output is used/seen by others).
It might be useful to borrow from the Journal of Open Source Software review criteria when developing a checklist for code reviewers: https://joss.readthedocs.io/en/latest/review_criteria.html#review-items
- Dominant language
- Jupyter Notebook
- Stars
- 1
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
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.
More from AusClimateService/data-code-group
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
-
Submitting to CORDEX Open
Difficulty 5/5 Over a week Newbie friendliness 15/100
-
xv83 cleanup Open
AusClimateService/data-code-group#18 · 3 comments · 3 assignees ·
-
AusClimateService/data-code-group#17 · 2 comments · 2 reactions · 1 assignee ·
-
notes
Difficulty 5/5 Over a week Newbie friendliness 25/100