[Page Request] Designing a mod API

Open
#174 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
20/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
api, documentation

Research direction

No file, test, or entry point is named. Start by reviewing the existing documentation structure and the discussion around recommended mod API guidelines, then identify the intended scope with maintainers and contributors. Done means an agreed set of guidelines is documented and the community input has been incorporated.

Written by the indexing model from the issue text.

Description

Page Request

Basically some "recommended guidelines" for what mod APIs should look like.
Ama said in stream chat he's had it planned, I'm just adding it here so people can add their input and for it to be officially on the todo-list ^-^

Dominant language
HTML
Stars
513
Forks
192
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

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.

More from MinecraftForge/Documentation

All issues in MinecraftForge/Documentation

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.