MetOffice / MetOffice/simulation-systems
Follow Style Guide
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 57
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
The LFRic Core style guide for sphinx documentation is very close to what we currently do in the working practices. It would seem sensible to make sure we are following this and then stick to it from now on.
https://metoffice.github.io/lfric_core/how_to_contribute/style_guides/documentation_style_guide.html
Contributor guide
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 reading the linked LFRic Core documentation style guide and comparing it with the repository's current working practices. Identify the documentation guidance that differs and update the relevant practices so they consistently follow the guide.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100