PrismarineJS / PrismarineJS/minecraft-data

Properly document every native type

Open
#161 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

protocol
Dominant language
JavaScript
Stars
937
Forks
294
Avg merge
2d 10h
Merged PRs (30d)
23

Description

We should make sure all our native types (like entityMetadataLoop) are documented in a similar fashion to https://github.com/ProtoDef-io/ProtoDef/blob/master/doc/datatypes.md

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the entityMetadataLoop native type with the linked ProtoDef doc/datatypes.md reference, then locate the other native types in this repository. Document each native type in a similar fashion; the work is done when every native type is covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.