Skip to content

Start contributing.md #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
cassiancc wants to merge 2 commits into from
Closed

Start contributing.md #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cd7236
Start contributing docs
cassiancc Nov 2, 2026
44f0969
fix: alphabetical order
cassiancc Nov 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
!.gitignore
!build.gradle
!config.json
!CONTRIBUTING.md
!CONVENTIONS.md
!gradle.properties
!gradlew
Expand Down
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Contributing

## Setup

It's fairly simple to begin contributing Javadocs.

### Prerequisites

- You have an account on [GitHub](https://github.com), and know how to use basic GitHub functions such as Pull Requests.
- You have basic knowledge of [git](https://docs.github.com/en/get-started/using-git/about-git) (such as what commits are, what branches are), and using it (cloning a repository, pushing, pulling). This guide assumes you are using the terminal/command line for git operations. If you are using a GUI for git, please consult that application's manual/user guide on how to do these operations.
- You have access to a Chromium-based web browser. Annotater's editor makes use of the [Filesystem API](https://caniuse.com/filesystem), which is currently unsupported in Safari and Firefox based browsers.

Before contributing documentation, please be sure to read our [naming conventions](./CONVENTIONS.md).

### Steps

1. **Fork the repository.** Forking the repository creates a copy of the repository (your _fork_) at your personal account, where you push your own commits to your branches.

1. **Clone your forked repository locally.** The repository directory can have any name, by default cloning will make a directory with the same name as the repository.
Comment on lines +17 to +19

@ErrorCraft ErrorCraft Nov 5, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Is it really necessary to explain what a fork and cloning is, especially since the document also requires you to have basic knowledge of git?

@cassiancc cassiancc Nov 5, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Probably not, but it's a short reminder more than a detailed expalnation.


1. **Open mcsrc.dev and select the Settings gear icon in the top left, select Tools in the left sidebar, then click Open Annotater directory.** [mcsrc.dev](https://mcsrc.dev/) allows you to view the Minecraft source and add Javadocs. This will give the site permission to write to your local Annotater repository, making it far easier to contribute documentation

@ErrorCraft ErrorCraft Nov 5, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
1. **Open mcsrc.dev and select the Settings gear icon in the top left, select Tools in the left sidebar, then click Open Annotater directory.** [mcsrc.dev](https://mcsrc.dev/) allows you to view the Minecraft source and add Javadocs. This will give the site permission to write to your local Annotater repository, making it far easier to contribute documentation
1. **Open [mcsrc.dev](https://mcsrc.dev/) and select the *Settings* gear icon in the top left. Then select *Tools* in the left sidebar, click on *Open Annotater directory* and select your local repository. Your browser will then ask for permission to write to your file system.** The website allows you to view the decompiled Minecraft source and add Javadocs to it.

Do you think it would be nice to have images in here as well so people can see what they have to do? On top of that, maybe you could split this section up into smaller steps instead of bunching all of opening Annotater in one big step, as it's a lot of small things to ask for?

Image

@cassiancc cassiancc Nov 5, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Absolutely, I think images would be handy. I was also considering checking with modmuss to see if mcsrc could be updated to allow linking directly to the Javadoc settings panel, I'll do that now.


1. **Write Javadocs.**
- 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.

1. **Commit and push your changes.** Once you're done making changes, save your work by committing it and pushing it to GitHub.

1. **Open a Pull Request.** Pull Requests are reviewed and merged by our triage team, currently being assembled.