Skip to content

Commit

Permalink
Updated documentation on contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
Noggog committed Oct 13, 2024
1 parent c523b6b commit 23b7f0a
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 5 deletions.
34 changes: 29 additions & 5 deletions docs/Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ If there's something small like a typo or a single sentence to improve, these ca

![Updating Docs from Github](images/Editing-Docs-On-Github.png){ align=right width="350" }

This will open an editor, and allow you to Fork and/or initiate a PR directly from the website.
This will open an editor and allow you to initiate a PR directly from the website with your changes.

You can of course do the same changes and PR proposals more traditionally by forking, cloning locally, and initiating a PR from there.

Expand All @@ -32,29 +32,53 @@ To do this, you will want to:

#### Fork Mutagen Repository

This step makes a copy of the Mutagen repo on Github that you have ownership of and can modify and prep your changes.

![Forking Mutagen](images/forking.png){ width="350" }

#### Download (Clone)
Cloning your forked repository to your computer. [GitKraken](https://www.gitkraken.com/) is a good Git client to help, but there's lots of alternatives

This step downloads (clones) the fork you just made to your local computer.

[GitKraken](https://www.gitkraken.com/) is a good Git client to help, but there's lots of alternatives

![Cloning](images/cloning.png){ width="350" }

#### Installing MkDocs
This is the documentation system Mutagen uses, so you have to install it so it can display the docs as you edit them.

[Installing Material for MkDocs](https://squidfunk.github.io/mkdocs-material/getting-started/)

TLDR: `pip install mkdocs-material` in a command line

#### Running MkDocs
Running `mkdocs serve` on your cloned Mutagen repository

This step runs MkDocs and tells it to watch Mutagen's documentation and display the changes.

Control-Click on the "Serving On" address to open it in your browser and see the docs as you write them.

![Running MkDocs](images/mkdocs-serve.png){ width="350" }


#### Edit Documentation

Use the [MkDocs guide](https://squidfunk.github.io/mkdocs-material/reference/) for all the neat things you can do.

#### Commit
Commit your changes in Git.
#### Commit, Push

This step saves your changes locally and prepares them to be uploaded and merged.

Once committed, you can Push them up to your Fork on GitHub's servers
![Commit Changes](images/committing.png){ width="350" }

#### Create Pull Request
This step officially makes the request for the Mutagen repository to bring in the changes you made on your Fork.

The easiest way is to click this button, which GitHub shows on your fork's `Pull Requests` tab for a short while after you push

![Creating PR](images/creating-PR.png){ width="350" }

After that, the Mutagen team can merge in your documentation updates! Feel free to comment on the PR itself, or get in touch on [Discord](https://discord.gg/53KMEsW) to chat about what you changed and why.


![Commit Changes](images/committing.png){ width="350" }
Binary file modified docs/images/committing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/creating-PR.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 23b7f0a

Please sign in to comment.