From af2335b33700b7e6447349bb79f526ba9f3cd78e Mon Sep 17 00:00:00 2001 From: Nathan Date: Thu, 23 Apr 2015 18:54:20 -0400 Subject: [PATCH 1/5] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d621fd4b5e..98e4a06a4f 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,8 @@ We welcome pull requests from Free Code Camp "campers" (our students) and season 1. Check our [public Waffle Board](https://waffle.io/freecodecamp/freecodecamp). 2. Pick an issue that nobody has claimed and start working on it. If your issue isn't on the board, open an issue. If you think you can fix it yourself, start working on it. Feel free to ask for help in our [Slack](http://freecode.slack.com). -3. Once your code is ready, submit a pull request. Please note that the code you submit should conform to [AirBnB's Style Guide](https://github.com/airbnb/javascript). We'll do a quick code review and give you feedback, and iterate from there. +3. Fork the project, you can find a quick tutorial [here](https://help.github.com/articles/fork-a-repo/). You'll do all of your work on this forked copy. We recommend creating a branch specific to the issue or feature you are working on and pushing your work to that branch. You can do this easily with the command `git checkout -b user-xxx` where user is your username and xxx is the issue number you are addressing. +4. Once your code is ready, submit a pull request from your branch to the `staging` branch. Please note that the code you submit should conform to [AirBnB's Style Guide](https://github.com/airbnb/javascript). We'll do a quick code review and give you feedback, and iterate from there. Project Structure ----------------- From b892d10c0d97e29d47a7908c1018770012a692dc Mon Sep 17 00:00:00 2001 From: Nathan Date: Thu, 23 Apr 2015 19:00:55 -0400 Subject: [PATCH 2/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 98e4a06a4f..d51afa3498 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ We welcome pull requests from Free Code Camp "campers" (our students) and season 1. Check our [public Waffle Board](https://waffle.io/freecodecamp/freecodecamp). 2. Pick an issue that nobody has claimed and start working on it. If your issue isn't on the board, open an issue. If you think you can fix it yourself, start working on it. Feel free to ask for help in our [Slack](http://freecode.slack.com). -3. Fork the project, you can find a quick tutorial [here](https://help.github.com/articles/fork-a-repo/). You'll do all of your work on this forked copy. We recommend creating a branch specific to the issue or feature you are working on and pushing your work to that branch. You can do this easily with the command `git checkout -b user-xxx` where user is your username and xxx is the issue number you are addressing. +3. Fork the project, you can find a quick tutorial [here](https://help.github.com/articles/fork-a-repo/). You'll do all of your work on this forked copy. We recommend creating a branch specific to the issue or feature you are working on and pushing your work to that branch. Follow along with [this](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches) tutorial for how to make your own branch. Name the branch something like `user-xxx` where user is your username and xxx is the issue number you are addressing. 4. Once your code is ready, submit a pull request from your branch to the `staging` branch. Please note that the code you submit should conform to [AirBnB's Style Guide](https://github.com/airbnb/javascript). We'll do a quick code review and give you feedback, and iterate from there. Project Structure From 2caf37fab4ece2d4c0bd3f711d6019f939b2a018 Mon Sep 17 00:00:00 2001 From: Nathan Date: Thu, 23 Apr 2015 19:05:27 -0400 Subject: [PATCH 3/5] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d51afa3498..c42e21213f 100644 --- a/README.md +++ b/README.md @@ -76,8 +76,9 @@ We welcome pull requests from Free Code Camp "campers" (our students) and season 1. Check our [public Waffle Board](https://waffle.io/freecodecamp/freecodecamp). 2. Pick an issue that nobody has claimed and start working on it. If your issue isn't on the board, open an issue. If you think you can fix it yourself, start working on it. Feel free to ask for help in our [Slack](http://freecode.slack.com). -3. Fork the project, you can find a quick tutorial [here](https://help.github.com/articles/fork-a-repo/). You'll do all of your work on this forked copy. We recommend creating a branch specific to the issue or feature you are working on and pushing your work to that branch. Follow along with [this](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches) tutorial for how to make your own branch. Name the branch something like `user-xxx` where user is your username and xxx is the issue number you are addressing. -4. Once your code is ready, submit a pull request from your branch to the `staging` branch. Please note that the code you submit should conform to [AirBnB's Style Guide](https://github.com/airbnb/javascript). We'll do a quick code review and give you feedback, and iterate from there. +3. Notify one of the project owners (currently @quincylarson, @terakilobyte, and @berkeleytrue) in our Slack room that you'd like to be added to the camper contributors group. +4. Fork the project, you can find a quick tutorial [here](https://help.github.com/articles/fork-a-repo/). You'll do all of your work on this forked copy. We recommend creating a branch specific to the issue or feature you are working on and pushing your work to that branch. Follow along with [this](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches) tutorial for how to make your own branch. Name the branch something like `user-xxx` where user is your username and xxx is the issue number you are addressing. +5. Once your code is ready, submit a pull request from your branch to the `staging` branch. Please note that the code you submit should conform to [AirBnB's Style Guide](https://github.com/airbnb/javascript). We'll do a quick code review and give you feedback, and iterate from there. Project Structure ----------------- From bc2069d80ecaa3d2b1d029374c478363929fe677 Mon Sep 17 00:00:00 2001 From: Nathan Date: Thu, 23 Apr 2015 20:22:14 -0400 Subject: [PATCH 4/5] Update README.md --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c42e21213f..6d3b048b71 100644 --- a/README.md +++ b/README.md @@ -76,9 +76,10 @@ We welcome pull requests from Free Code Camp "campers" (our students) and season 1. Check our [public Waffle Board](https://waffle.io/freecodecamp/freecodecamp). 2. Pick an issue that nobody has claimed and start working on it. If your issue isn't on the board, open an issue. If you think you can fix it yourself, start working on it. Feel free to ask for help in our [Slack](http://freecode.slack.com). -3. Notify one of the project owners (currently @quincylarson, @terakilobyte, and @berkeleytrue) in our Slack room that you'd like to be added to the camper contributors group. -4. Fork the project, you can find a quick tutorial [here](https://help.github.com/articles/fork-a-repo/). You'll do all of your work on this forked copy. We recommend creating a branch specific to the issue or feature you are working on and pushing your work to that branch. Follow along with [this](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches) tutorial for how to make your own branch. Name the branch something like `user-xxx` where user is your username and xxx is the issue number you are addressing. -5. Once your code is ready, submit a pull request from your branch to the `staging` branch. Please note that the code you submit should conform to [AirBnB's Style Guide](https://github.com/airbnb/javascript). We'll do a quick code review and give you feedback, and iterate from there. +3. Fork the project, you can find a quick tutorial [here](https://help.github.com/articles/fork-a-repo/). You'll do all of your work on this forked copy. We recommend creating a branch specific to the issue or feature you are working on and pushing your work to that branch. Follow along with [this](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches) tutorial for how to make your own branch. Name the branch something like `user-xxx` where user is your username and xxx is the issue number you are addressing. +4. Once your code is ready, submit a pull request from your branch to Free Code Camp's `staging` branch. Please note that the code you submit should conform to [AirBnB's Style Guide](https://github.com/airbnb/javascript). If you have eslint running it should highlight anything doesn't stylistically conform. Please do not ignore any linting errors as they are meant to **help** you. Though is not specified in the guide, we have a rule for maximum line lengths of 80. We'll do a quick code review and give you feedback, then iterate from there. +5. One of the project owners (currently @quincylarson, @terakilobyte, and @berkeleytrue) will add you to a contributor group if your PR is accepted. + Project Structure ----------------- From ef60528632b28d6d6495b8494005b1777f7684e9 Mon Sep 17 00:00:00 2001 From: Quincy Larson Date: Thu, 23 Apr 2015 17:51:45 -0700 Subject: [PATCH 5/5] Update README.md --- README.md | 39 +++++++++++++++++++++++++-------------- 1 file changed, 25 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 6d3b048b71..f9195f6601 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,34 @@ [![Stories in Ready](https://badge.waffle.io/FreeCodeCamp/freecodecamp.png?label=ready&title=Ready)](https://waffle.io/FreeCodeCamp/freecodecamp) -Free Code Camp! +Welcome to Free Code Camp's open source codebase! ======================= -We're a community of busy people learning to code by collaborating on projects for nonprofits. We learn, then use, the JavaScript MEAN stack - MongoDB, Express.js, Angular.js and Node.js. +Free Code Camp is an open-source community of busy people who learn to code, then build projects for nonprofits. -This app is live at [FreeCodeCamp.com](http://www.FreeCodeCamp.com), and we have a [chat room](https://gitter.im/FreeCodeCamp/FreeCodeCamp) and [blog](http://blog.freecodecamp.com), too. Join us! +Our campers (students) start by working through our free, self-paced, browser-based curriculum. Next, they build several practice projects. Finally, we pair two campers together with a stakeholder from a nonprofit organization, and help them build the solution the nonprofit has requested. + +**We help our campers build job-worthy portfolios of real apps used by real people, while helping nonprofits.** + +80% of our campers are over 25, and nearly a fifth of our campers are women. + +This code is running live at [FreeCodeCamp.com](http://www.FreeCodeCamp.com). We also have [Slack](http://freecode.slack.com), a [blog](http://blog.freecodecamp.com), and even a [Twitch.tv channel](http://twitch.tv/freecodecamp). + +[Join our community](http://www.freecodecamp.com/signin)! + +Contributing +------------ + +We welcome pull requests from Free Code Camp campers (our students) and seasoned JavaScript developers alike! Follow these steps to contribute: + +1. Check our [public Waffle Board](https://waffle.io/freecodecamp/freecodecamp). +2. Pick an issue that nobody has claimed and start working on it. If your issue isn't on the board, open an issue. If you think you can fix it yourself, start working on it. Feel free to ask for help in our [Slack](http://freecode.slack.com). +3. Fork the project ([Need help with forking a project?](https://help.github.com/articles/fork-a-repo/)). You'll do all of your work on your forked copy. +4. Create a branch specific to the issue or feature you are working on. Push your work to that branch. ([Need help with branching?](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches)) +5. Name the branch something like `user-xxx` where user is your username and xxx is the issue number you are addressing. +6. You should have [ESLint running in your editor](http://eslint.org/docs/user-guide/integrations.html), and it will highlight anything doesn't conform to [AirBnB's JavaScript Style Guide](https://github.com/airbnb/javascript). Please do not ignore any linting errors, as they are meant to **help** you. Make sure none of your JavaScript is longer than 80 characters per line. +7. Once your code is ready, submit a pull request from your branch to Free Code Camp's `staging` branch. We'll do a quick code review and give you feedback, then iterate from there. +8. Once we accept one of your pull requests, one of the project owners (currently @quincylarson, @terakilobyte, and @berkeleytrue) will add you to our camper contributor group. Prerequisites ------------- @@ -69,17 +91,6 @@ gulp ``` -Contributing ------------- - -We welcome pull requests from Free Code Camp "campers" (our students) and seasoned JavaScript developers alike! Follow these steps to contribute: - -1. Check our [public Waffle Board](https://waffle.io/freecodecamp/freecodecamp). -2. Pick an issue that nobody has claimed and start working on it. If your issue isn't on the board, open an issue. If you think you can fix it yourself, start working on it. Feel free to ask for help in our [Slack](http://freecode.slack.com). -3. Fork the project, you can find a quick tutorial [here](https://help.github.com/articles/fork-a-repo/). You'll do all of your work on this forked copy. We recommend creating a branch specific to the issue or feature you are working on and pushing your work to that branch. Follow along with [this](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches) tutorial for how to make your own branch. Name the branch something like `user-xxx` where user is your username and xxx is the issue number you are addressing. -4. Once your code is ready, submit a pull request from your branch to Free Code Camp's `staging` branch. Please note that the code you submit should conform to [AirBnB's Style Guide](https://github.com/airbnb/javascript). If you have eslint running it should highlight anything doesn't stylistically conform. Please do not ignore any linting errors as they are meant to **help** you. Though is not specified in the guide, we have a rule for maximum line lengths of 80. We'll do a quick code review and give you feedback, then iterate from there. -5. One of the project owners (currently @quincylarson, @terakilobyte, and @berkeleytrue) will add you to a contributor group if your PR is accepted. - Project Structure -----------------