Skip to content

Instantly share code, notes, and snippets.

@omaraboumrad omaraboumrad/wiki.md
Last active Jun 21, 2016

Embed
What would you like to do?
How to contribute to a GitHub Project's Wiki

Setup

Assuming project is SOME/PROJECT And you are FOO

You will need to do the following one time only:

git remote add upstream https://github.com/SOME/PROJECT.wiki.git
  • Fetch the latest master:
git fetch upstream master

Keeping your fork in sync

git checkout master
git fetch upstream master
git merge upstream/master
git push origin master

Submitting changes to your fork

git checkout master
git add your/change/here
git commit -m "single line sub 50 char description"
git push origin master

Submitting changes to the main repository

When you're ready to submit, you need to open an issue https://github.com/SOME/PROJECT/issues and provide the following:

  • Link to your repository.
  • Description to the change you've done.

Core Contributors

Reviewing Changes

As a core contributor you can review the changes done using:

git checkout -b FOO-master
git pull https://github.com/FOO/PROJECT.wiki.git master

Merging Changes

As a core contributors you can merge the changes done using:

git checkout master
git merge --no-ff FOO-master
git push origin master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.