diff --git a/README.md b/README.md index 3fb2720..887b4c5 100644 --- a/README.md +++ b/README.md @@ -5,21 +5,20 @@ Our open source community's Wiki focuses on answering your questions about learn - Curriculum - Other Programming Languages - Local Campsite Communities -- Nonprofit Projects - ...and much more +- Nonprofit Projects and much more -*Taste* the wiki at [**FreeCodeCamp/wiki**](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki) :yum: +*Taste* the wiki at [**FreeCodeCamp/wiki**](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki) :yum: -## +## Steps to follow -### 1. **Fork it** :fork_and_knife: +### 1. **Fork it** :fork_and_knife: You can get your own fork/copy of [FreeCodeCamp wiki](https://github.com/FreeCodeCamp/wiki) by using the Fork button or clicking [this](https://github.com/FreeCodeCamp/wiki/new/master?readme=1#fork-destination-box). -> [![Fork Button](https://help.github.com/assets/images/help/repository/fork_button.jpg)](https://github.com/FreeCodeCamp/wiki) + [![Fork Button](https://help.github.com/assets/images/help/repository/fork_button.jpg)](https://github.com/FreeCodeCamp/wiki) -### 2. **Clone it** :busts_in_silhouette: +### 2. **Clone it** :busts_in_silhouette: Once you have forked the wiki repository in Github, you need to clone/download it to local machine with... - + ```sh $ git clone https://github.com/YOUR_USERNAME/wiki.git ``` @@ -27,7 +26,7 @@ $ git clone https://github.com/YOUR_USERNAME/wiki.git > *this makes a local copy in your machine.* ### 3. **Set it up** :up: -Run the following commands to see that _your local copy_ has a reference to _your forked remote repository_ in Github :octocat: +Run the following commands to see that _your local copy_ has a reference to _your forked remote repository_ in Github :octocat: ```sh $ git remote -v @@ -42,11 +41,11 @@ Now lets add a reference to the original [FreeCodeCamp wiki](https://github.com/ $ git remote add upstream https://github.com/FreeCodeCamp/wiki.git ``` -> this adds a new remote named **upstream**. +> this adds a new remote named **upstream**. You may see the changes with... -> ```sh +```sh $ git remote -v origin https://github.com/YOUR_USERNAME/wiki.git (fetch) origin https://github.com/YOUR_USERNAME/wiki.git (push) @@ -60,37 +59,31 @@ Before making any changes and/or in an appropriate interval, run the following c ```sh # fetch all remote repos and delete any deleted remote branches -$ git fetch --all --prune +$ git fetch --all --prune # switch to `master` branch -$ git checkout master +$ git checkout master # reset local `master` branch to match `upstream` repo's `master` branch -$ git reset --hard upstream/master +$ git reset --hard upstream/master # push changes to your forked wiki repo -$ git push origin master +$ git push origin master ``` -### 5. Ready Steady Go... :turtle: :rabbit2: +### 5. Ready Steady Go... :turtle: :rabbit2: Once you have completed these steps, you are ready to start contributing by checking our [![Help Wanted Issues](https://img.shields.io/badge/Wiki-Help_Wanted_Issues-159818.svg?style=flat-square&maxAge=2592000)](https://github.com/FreeCodeCamp/wiki/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 "Help Wanted Issues") and creating *new shiny* :sparkles: [pull requests](https://github.com/FreeCodeCamp/wiki/pulls). ## 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](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/Wiki) Page such as +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](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/Wiki) Page such as contributing using: -> Contributing Using -- **Browser** *mostly* :earth_americas: -- and **Desktop application** :computer: +- **Browser** :earth_americas: +- **Desktop application** :computer: - -_**Happy Contributing**_ :smiley: -
-
+_**Happy Contributing**_ :smiley: -> ----

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

- -> ---- diff --git a/Wiki-Contribute-Fork.md b/Wiki-Contribute-Fork.md new file mode 100644 index 0000000..ad9cedd --- /dev/null +++ b/Wiki-Contribute-Fork.md @@ -0,0 +1,82 @@ +# How to get a fork of 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** :fork_and_knife: +You can get your own fork/copy of [FreeCodeCamp wiki](https://github.com/FreeCodeCamp/wiki) by using the Fork button or clicking [this](https://github.com/FreeCodeCamp/wiki/new/master?readme=1#fork-destination-box). + + [![Fork Button](https://help.github.com/assets/images/help/repository/fork_button.jpg)](https://github.com/FreeCodeCamp/wiki) + +### 2. **Clone it** :busts_in_silhouette: +Once you have forked the wiki repository in Github, you need to clone/download it to local machine with... + +```sh +$ git clone https://github.com/YOUR_USERNAME/wiki.git +``` + +> *this makes a local copy in your machine.* + +### 3. **Set it up** :up: +Run the following commands to see that _your local copy_ has a reference to _your forked remote repository_ in Github :octocat: + +```sh +$ git remote -v +origin https://github.com/YOUR_USERNAME/wiki.git (fetch) +origin https://github.com/YOUR_USERNAME/wiki.git (push) +``` + +Magic :sparkles: :sparkles: :eyes: +Now lets add a reference to the original [FreeCodeCamp wiki](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki) repository with... + +```sh +$ git remote add upstream https://github.com/FreeCodeCamp/wiki.git +``` + +> this adds a new remote named **upstream**. + +You may see the changes with... + +```sh +$ 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** :recycle: +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. + +```sh +# 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... :turtle: :rabbit2: +Once you have completed these steps, you are ready to start contributing by checking our [![Help Wanted Issues](https://img.shields.io/badge/Wiki-Help_Wanted_Issues-159818.svg?style=flat-square&maxAge=2592000)](https://github.com/FreeCodeCamp/wiki/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 "Help Wanted Issues") and creating *new shiny* :sparkles: [pull requests](https://github.com/FreeCodeCamp/wiki/pulls). + +## 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](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/Wiki) Page such as contributing using: + +- **Browser** :earth_americas: +- **Desktop application** :computer: + + + +_**Happy Contributing**_ :smiley: + +

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

diff --git a/Wiki.md b/Wiki.md index 85b81cc..ff30968 100644 --- a/Wiki.md +++ b/Wiki.md @@ -42,6 +42,7 @@ You can also access them from Gitter using Camperbot We currently have a couple of guides to help you contribute, via the browser, command line or desktop application. - [How To Contribute From Your Browser:](Wiki-Contribute-Online) This is currently the easiest way we have to contribute. A simplified version can be found on [here](https://medium.freecodecamp.com/how-to-land-your-first-open-source-contribution-from-your-browser-in-15-minutes-756d9bbf81ad) also. +- [How to fork our wiki](Wiki-Contribute-Fork) This will show you how to fork our wiki while being able to keep your fork syncronized. - [How To Contribute To The Wiki Locally:](Wiki-Contribute-Local-GUI) This is a guide that will show you how to have a local copy so you can make changes from your computer, it also works for contributing to the main repository. - [Pull Request Guidelines](PULL_REQUEST_TEMPLATE) - [More on how to make a pull request from a fork](Pull-Request-Contribute)