Materials-Consortia / Materials-Consortia/optimade-python-tools
Fix typos in models versus specification
Open
Nobody has claimed this yet.
help wanted
OPTIMADE v1.2
- Dominant language
- Python
- Stars
- 91
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
Description
We need to check the diff compared to v1.1 and fix any typos/clarifications in our model/field descriptions that have been fixed upstream.
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
Compare the repository's model and field descriptions with the upstream v1.1 specification, starting with the model definitions referenced by the issue. Update only typos or clarifications that differ from upstream; done means the descriptions match the v1.1 wording and intended meaning.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100