Skip to content

Start contributing docs - #8

Open
cassiancc wants to merge 2 commits into
FabricMC:26.3from
cassiancc:contributing
Open

cassiancc wants to merge 2 commits into
FabricMC:26.3from
cassiancc:contributing

Conversation

@cassiancc

Copy link
Copy Markdown
Member

Adds basic information about how to contribute using mcsrc.dev. Structure and some wording are pulled from Parchment's contributing guidelines, which are licensed under CC0.

References #7 , so this PR should be merged after that one. Rebased from #6 .

@cassiancc
cassiancc requested a review from a team as a code owner November 6, 2026 16:48

@NotNightSky NotNightSky left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need to explain the basics? If someone can read Minecraft's code and explain it to others, I’d assume they already have a GitHub account and know the basics of Git.

Comment thread CONTRIBUTING.md
Comment on lines +24 to +26
- Classes are listed at the left section of the interface, and a search bar is available in the top left. Click on a class to open it.
- To add Javadocs to a class, field, or method, click `Edit Javadoc` above the class, field, or method in question.
- Changes are saved automatically.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding images would be nice.

@cputnam-a11y

Copy link
Copy Markdown

Do we really need to explain the basics? If someone can read Minecraft's code and explain it to others, I’d assume they already have a GitHub account and know the basics of Git.

Ideally this will be open to people without an existing GitHub account and git skills. Mcdev and mcsrc will hopefully have streamlines paths with limited required git skills

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants