Repository navigation
Start contributing docs #8
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.
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
Open
cassiancc
wants to merge
2
commits into
FabricMC:26.3
Choose a base branch
from
cassiancc:contributing
base: 26.3
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. | ||
|
|
||
| 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. **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. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.