How to Contribute

Thank you for your interest in contributing to this documentation page! Here we'll walk through the necessary steps needed to contribute to the project.

Clone the Repository

First, you'll want to clone the repository.

SSHHTTPS

Bash

git clone git@github.com:nrdavid/whsun-docs.git

Bash

git clone https://github.com/nrdavid/whsun-docs.git

Creating a new branch

Once you've cloned the repository, you can create a new branch with the topic you'd like to contribute with. For example, I'm adding a section on "How to contribute" so maybe I'd name my branch "contributing". This will create the new branch and enter it.

Bash

git checkout -b <BRANCH_NAME>

Set your upstream for the branch.

Bash

git branch --set-upstream-to=origin/<BRANCH_NAME>  <BRANCH_NAME>

Then push you branch to the remote git push.

Making your changes

To add your section to the navigation bar, go to mkdocs.yml and add your section to the nav tree. You will also need to create a new markdown file (and folder if necessary).

NO OTHER PORTION OF mkdocs.yml SHOULD BE MODIFIED

You should also follow the conventions laid out in other sections like adding a imgs folder for you images.

Adding your section to the nav tree.

Commit, Push, and PR

Once your changes are done, add, commit, pull, rebase, and push them to the remote. Please make your messages meaningful.

Pull the latest changes and rebase your changes to main to create an easier pull request.

Bash

git checkout main 
git pull

Bash

git checkout <BRANCH_NAME>
git rebase main <BRANCH_NAME>

You may need to resolve some conflicts between your branch and main.

After that, go to the repository online and create a pull request to main. @nrdavid will then review the request!

Post PR approval

After your PR has been approved and merged into main, you should clean up your branch if you're no longer using it.

Bash

git push -d origin <BRANCH_NAME>

Bash

git branch -D <BRANCH_NAME>

Lastly, you should pull the recent changes from main into your local.

That's it. Thank you!