PrismarineJS / PrismarineJS/minecraft-data
Add a data-schema.md to explain minecraft data schemas
Open
Nobody has claimed this yet.
documentation
- Dominant language
- JavaScript
- Stars
- 938
- Forks
- 294
- Avg merge
- 3d 5h
- Merged PRs (30d)
- 25
Description
In particular it would explain that minecraft-data prefer array vs indexed data (to let the wrapper index how they want).
Useful for new people adding data to mcdata.
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 how minecraft-data represents schemas and how wrappers consume them. Add the proposed data-schema.md explaining the preference for array versus indexed data and how that lets wrappers choose their indexing approach. Done means the guidance is clear enough for new contributors adding data to mcdata.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100