PaperMC / PaperMC/Paper

Mention the use of paper-generator in CONTRIBUTING.md

Open
#13,563 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

status: accepted type: documentation
Dominant language
Java
Stars
12.7k
Forks
3.5k
Avg merge
3d 13h
Merged PRs (30d)
11

Description

Is your feature request related to a problem?

Currently the generator its not mentioned in any place of the CONTRIBUTION this can cause a few PR for add stuff ignore the existence of that and also not mention a basic way to use unless you check the tasks, in discord a mention about this was check the commit where include info but that was squash in a commit and its hard to find.

Describe the solution you'd like.

Document the paper-generator in the CONTRIBUTING.md for reference

Describe alternatives you've considered.

N/A

Other

No response

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.

Research direction

Start with CONTRIBUTING.md and the tasks that currently explain how to use paper-generator. Add a concise reference and basic usage guidance there; done when contributors can find and use the generator without searching commit history or Discord.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.