Wiki Contribute Fork - ashish9342/FreeCodeCamp GitHub Wiki

How to Fork our Wiki and Keep It Syncronized

These steps are standard for contributing not only to our wiki but any other project once you understand what is going on.

Steps to follow

1. Fork it 🍴

You can get your own fork/copy of FreeCodeCamp wiki by using the Fork button or clicking this.

Fork Button

2. Clone it 👥

Once you have forked the wiki repository in Github, you need to clone/download it to local machine with...

$ git clone https://github.com/YOUR_USERNAME/wiki.git

this makes a local copy in your machine.

3. Set it up 🆙

Run the following commands to see that your local copy has a reference to your forked remote repository in Github :octocat:

$ git remote -v
origin  https://github.com/YOUR_USERNAME/wiki.git (fetch)
origin  https://github.com/YOUR_USERNAME/wiki.git (push)

Magic ✨ ✨ 👀
Now lets add a reference to the original FreeCodeCamp wiki repository with...

$ git remote add upstream https://github.com/FreeCodeCamp/wiki.git

this adds a new remote named upstream.

You may see the changes with...

$ git remote -v
origin    https://github.com/YOUR_USERNAME/wiki.git (fetch)
origin    https://github.com/YOUR_USERNAME/wiki.git (push)
upstream  https://github.com/FreeCodeCamp/wiki.git (fetch)
upstream  https://github.com/FreeCodeCamp/wiki.git (push)

4. Sync it ♻️

Always keep your local copy of repository updated with the original repository.
Before making any changes and/or in an appropriate interval, run the following commands carefully to update your local repository.

# fetch all remote repos and delete any deleted remote branches
$ git fetch --all --prune

# switch to `master` branch
$ git checkout master

# reset local `master` branch to match `upstream` repo's `master` branch
$ git reset --hard upstream/master

# push changes to your forked wiki repo
$ git push origin master

5. Ready Steady Go... 🐢 🐇

Once you have completed these steps, you are ready to start contributing by checking our Help Wanted Issues and creating new shinypull requests.

Help Contributing Guides

We also have guides in our Wiki to assist you in your contributions. You can find this and many more guides, tutorials and other information in the Wiki Central Page such as contributing using:

  • Browser 🌎
  • Desktop application 💻

Happy Contributing 😃

Need Help? Read CONTRIBUTING Guidelines
or Chat with us in FreeCodeCamp/Wiki

⚠️ **GitHub.com Fallback** ⚠️