Repository navigation
Conversation
|
FYI I made my branch on this repo, so you can PR my PR easily if you want. |
27305cc to
6cd7236
Compare
| 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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Probably not, but it's a short reminder more than a detailed expalnation.
|
|
||
| 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 |
There was a problem hiding this comment.
| 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?
There was a problem hiding this comment.
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.
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 #5, so this PR should either be merged after that one or as part of that one.