MetOffice / MetOffice/CSET

Add development checklist item for ensuring recipe descriptions are sufficient

Open Beginner friendly
#2,254 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
33
Forks
19
Avg merge
1d 22h
Merged PRs (30d)
30

Description

### What problem does your feature request solve?

New recipes don't always have sufficient detail in their descriptions and reviews are not catching that.

### Describe the solution you'd like

Add development checklist item for ensuring recipe descriptions are sufficient.

New bullet point around scientific review, specifically mentioning recipe description. Reviews should make a judgement call over what can be referenced back to the original paper, etc., verses what needs to be described in the description itself.

### Describe alternatives you've considered

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the development checklist referenced in the issue and read nearby review guidance before editing. Add a scientific-review checklist item covering whether recipe descriptions provide enough detail or can appropriately refer back to the original paper. Done means the checklist clearly prompts reviewers to make that judgement.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.