From 27f80eddeabf14330c4c88e157812c036ccf4ec1 Mon Sep 17 00:00:00 2001 From: Quincy Larson Date: Wed, 15 Apr 2015 00:07:14 -0700 Subject: [PATCH] Update README.md with better contribution directions. Point to AirBnB styleguide. (closes #307) --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 04a84392b8..68b31e96fb 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,15 @@ 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. 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. + Project Structure ----------------- @@ -151,14 +160,6 @@ Changelog - Installed Helmet to maximize security of application - Added .env and removed all trace of API keys from git history -Contributing ------------- - -We welcome pull requests from Free Code Camp "campers" (our students) and seasoned JavaScript developers alike! -1) Check our [public Waffle Board](https://waffle.io/freecodecamp/freecodecamp) -2) If your issue or feature isn't on the board, open an issue and if you think you can fix it yourself, start working on it. -3) Once your code is ready, submit the pull request. We'll do a quick code review and give you feedback, and iterate from there. - License -------