Permalink
Please sign in to comment.
Browse files
Merge pull request #5732 from pmbenjamin/enhancement/consolidate-cont…
…ributors-instructions Consolidate contributors instructions into CONTRIBUTING.md
- Loading branch information...
2 parents
ef1f3d3
+
287c2af
commit 47d187243be782a4fd3a1c96f50041cafbf13691
SaintPeter
committed
SaintPeter
committed
Showing
with
182 additions
and 111 deletions.
- +181 −15 CONTRIBUTING.md
- +1 −96 README.md
196
CONTRIBUTING.md
| @@ -1,28 +1,194 @@ | ||
| -## Code Not Working? | ||
| -Do not file an issue until you have: | ||
| - | ||
| -1. Read [Help I've Found a Bug](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/Help-I've-Found-a-Bug) wiki page and followed the instructions there. | ||
| -2. Asked for confirmation in the appropriate [Help Room](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/Help-Rooms) | ||
| -3. Please *do not* open an issue without a 3rd party confirmation of your problem. | ||
| +# Contributors Guide | ||
| ## I want to help! | ||
| 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 [General Gitter Chat Room](https://gitter.im/FreeCodeCamp/FreeCodeCamp), or in our [Help Contributors Chat Room](https://gitter.im/FreeCodeCamp/HelpContributors) | ||
| -3. You can find issues we are seeking assistance on by searching for the [Help Wanted](https://github.com/FreeCodeCamp/FreeCodeCamp/labels/help%20wanted) tag. | ||
| +2. Pick an issue, let us know you're working on it, and start working on it. If you've found a bug that is not on the board, [follow these steps](#found-a-bug). | ||
| +3. You can find issues we are seeking assistance on by searching for the [Help Wanted](https://github.com/FreeCodeCamp/FreeCodeCamp/labels/help%20wanted) tag. | ||
| +4. Feel free to ask for help in our [Help Contributors](https://gitter.im/FreeCodeCamp/FreeCodeCamp) Gitter room. | ||
| ## Contribution Guidelines | ||
| 1. Fork the project: [How To Fork And Maintain a Local Instance of Free Code Camp](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/How-To-Fork-And-Maintain-a-Local-Instance-of-Free-Code-Camp) | ||
| 2. 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)) | ||
| - 3. Name the branch something like `fix/xxx` or `feature/xxx` where `xxx` is a short description of the changes or feature you are attempting to add. For example `fix/email-login` would be a branch where I fix something specific to email login. | ||
| +3. Name the branch something like `fix/xxx` or `feature/xxx` where `xxx` is a short description of the changes or feature you are attempting to add. For example `fix/email-login` would be a branch where I fix something specific to email login. | ||
| 4. 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 [Free Code Camp's JavaScript Style Guide](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/Free-Code-Camp-JavaScript-Style-Guide) (you can find a summary of those rules [here](https://github.com/FreeCodeCamp/FreeCodeCamp/blob/staging/.eslintrc). Please do not ignore any linting errors, as they are meant to **help** you and to ensure a clean and simple code base. Make sure none of your JavaScript is longer than 80 characters per line. | ||
| 5. Squash your Commits. Ref: [rebasing](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/git-rebase) | ||
| +6. Once your code is ready, submit a [pull request](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/Pull-Request-Contribute) 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. | ||
| + | ||
| + | ||
| +Prerequisites | ||
| +------------- | ||
| + | ||
| +- [MongoDB](http://www.mongodb.org/downloads) | ||
| +- [Node.js](http://nodejs.org) | ||
| + | ||
| +Getting Started | ||
| +--------------- | ||
| + | ||
| +The easiest way to get started is to clone the repository: | ||
| + | ||
| +```bash | ||
| +# Get the latest snapshot | ||
| +git clone --depth=1 https://github.com/freecodecamp/freecodecamp.git freecodecamp | ||
| + | ||
| +# Change directory | ||
| +cd freecodecamp | ||
| + | ||
| +# Install NPM dependencies | ||
| +npm install | ||
| + | ||
| +# Install Gulp globally | ||
| +npm install -g gulp | ||
| + | ||
| +# Install Bower globally | ||
| +npm install -g bower | ||
| + | ||
| +# Install Bower dependencies | ||
| +bower install | ||
| + | ||
| +# Create a .env file and populate it with the necessary API keys and secrets: | ||
| +touch .env | ||
| +``` | ||
| + | ||
| +Edit your `.env` file with the following API keys accordingly. If you only use email login, only the `MONGOHQ_URL`, `SESSION_SECRET`, `MANDRILL_USER` and `MANDRILL_PASSWORD` fields are necessary. Keep in mind if you want to use more services you'll have to get your own API keys for those services. If you only use a subset or no OAuth2 authentication methods, you may want to remove them from ```server/passport-providers.js``` - otherwise the server will complain about missing clientIDs at launch. | ||
| + | ||
| +``` | ||
| +MONGOHQ_URL='mongodb://localhost:27017/freecodecamp' | ||
| + | ||
| +FACEBOOK_ID=stuff | ||
| +FACEBOOK_SECRET=stuff | ||
| + | ||
| +GITHUB_ID=stuff | ||
| +GITHUB_SECRET=stuff | ||
| + | ||
| +GOOGLE_ID=stuff | ||
| +GOOGLE_SECRET=stuff | ||
| + | ||
| +LINKEDIN_ID=stuff | ||
| +LINKEDIN_SECRET=stuff | ||
| + | ||
| +MANDRILL_PASSWORD=stuff | ||
| +MANDRILL_USER=stuff | ||
| + | ||
| +TRELLO_KEY=stuff | ||
| +TRELLO_SECRET=stuff | ||
| + | ||
| +TWITTER_KEY=stuff | ||
| +TWITTER_SECRET=stuff | ||
| +TWITTER_TOKEN=stuff | ||
| +TWITTER_TOKEN_SECRET=stuff | ||
| + | ||
| +BLOGGER_KEY=stuff | ||
| + | ||
| +SESSION_SECRET=secretstuff | ||
| +COOKIE_SECRET='this is a secret' | ||
| + | ||
| +PEER=stuff | ||
| +DEBUG=true | ||
| +``` | ||
| + | ||
| +```bash | ||
| +# Start the mongo server in a seperate terminal | ||
| +mongod | ||
| + | ||
| +# Initialize Free Code Camp | ||
| +# This will seed the database for the first time. | ||
| +# This command should only be run once. | ||
| +npm run only-once | ||
| + | ||
| +# start the application | ||
| +gulp | ||
| +``` | ||
| +Now navigate to your browser and open http://localhost:3001 | ||
| +If the app loads, congratulations - you're all set. Otherwise, let us know by opening a GitHub issue and with your error. | ||
| + | ||
| + | ||
| +## Found a bug? | ||
| +Do not file an issue until you have followed these steps: | ||
| + | ||
| +1. Read [Help I've Found a Bug](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/Help-I've-Found-a-Bug) wiki page and follow the instructions there. | ||
| +2. Asked for confirmation in the appropriate [Help Room](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/Help-Rooms) | ||
| +3. Please *do not* open an issue without a 3rd party confirmation of your problem. | ||
| + | ||
| + | ||
| +## Creating Pull Requests | ||
| +**What is a Pull Request?** | ||
| + | ||
| +A pull request (PR) is a method of submitting proposed changes to the Free Code Camp Repo (or any Repo, for that matter). You will make changes to copies of the files which make up Free Code Camp in a personal fork, then apply to have them accepted by Free Code Camp proper. | ||
| + | ||
| +**Need Help?** | ||
| + | ||
| +Free Code Camp Issue Mods and staff are on hand to assist with Pull Request related issues on our Help Contributors Chat Room | ||
| + | ||
| +**Methods** | ||
| + | ||
| +There are two methods of creating a Pull for Free Code Camp: | ||
| + | ||
| +- Editing files via the GitHub Interface | ||
| +- Editing files on a local clone | ||
| + | ||
| +**Important: ALWAYS EDIT ON A BRANCH** | ||
| +Take away only one thing from this document, it should be this: Never, **EVER** make edits to the `staging` branch. ALWAYS make a new branch BEFORE you edit files. This is critical, because if your PR is not accepted, your copy of staging will be forever sullied and the only way to fix it is to delete your fork and re-fork. | ||
| + | ||
| +_**Method 1: Editing via your Local Fork (Recommended)**_ | ||
| +This is the recommended method. Read about How to Setup and Maintain a Local Instance of Free Code Camp. | ||
| + | ||
| +1. Perform the maintenance step of rebasing `staging`. | ||
| +2. Ensure you are on the `staging` branch using `git status`: | ||
| + | ||
| +```bash | ||
| +$ git status | ||
| +On branch staging | ||
| +Your branch is up-to-date with 'origin/staging'. | ||
| + | ||
| +nothing to commit, working directory clean | ||
| +``` | ||
| + | ||
| +3. If you are not on staging or your working directory is not clean, resolve any outstanding files/commits and checkout staging `git checkout staging` | ||
| +4. Create a branch off of `staging` with git: `git checkout -B branch/name-here` | ||
| +**Note:** Branch naming is important. Use a name like `fix/short-fix-description` or `feature/short-feature-description`. Review the [Contribution Guidelines](#contribution-guidelines) for more detail. | ||
| +5. Edit your file(s) locally with the editor of your choice | ||
| +6. Check your `git status` to see unstaged files. | ||
| +7. Add your edited files: `git add path/to/filename.ext` You can also do: `git add .` to add all unstaged files. Take care, though, because you can accidentially add files you don't want added. Review your `git status` first. | ||
| +8. Commit your edits: `git commit -m "Brief Description of Commit"` | ||
| +9. Squash your commits, if there are more than one. | ||
| +10. Push your commits to your GitHub Fork: `git push -u origin branch/name-here` | ||
| +11. Go to [Common Steps](#common-steps) | ||
| + | ||
| +_**Method 2: Editing via the GitHub Interface**_ | ||
| + | ||
| +Note: Editing via the GitHub Interface is not recommended, since it is not possible to update your fork via GitHub's interface without deleting and recreating your fork. | ||
| + | ||
| +Read the [Wiki article](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/How-To-Create-A-Pull-Request-for-Free-Code-Camp#editing-via-the-github-interface) for further information | ||
| + | ||
| +## Common Steps | ||
| +1. Once the edits have been committed, you will be prompted to create a pull request on your fork's Github Page. | ||
| +2. By default, all pull requests should be against the FCC main repo, `staging` branch. | ||
| +3. Submit a [pull request](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/Pull-Request-Contribute) from your branch to Free Code Camp's `staging` branch. | ||
| +3. The title (also called the subject) of your PR should be descriptive of your changes and succinctly indicates what is being fixed. | ||
| + - **Do not add the issue number in the PR title**. | ||
| + - Examples: `Add Test Cases to Bonfire Drop It` `Correct typo in Waypoint Size Your Images` | ||
| +4. In the body of your PR include a more detailed summary of the changes you made and why. | ||
| + - If the PR is meant to fix an existing bug/issue, then, at the end of your PR's commit message, append the keyword `closes` and #xxxx (where xxxx is the issue number). Example: `closes #1337`. | ||
| + This tells GitHub to close the existing issue, if the PR is merged. | ||
| +5. Indicate if you have tested on a local copy of the site or not. | ||
| + | ||
| +## Next Steps | ||
| + | ||
| +**If your PR is accepted** | ||
| + | ||
| +Once your PR is accepted, you may delete the branch you created to submit it. This keeps your working fork clean. | ||
| + | ||
| +You can do this with a press of a button on the GitHub PR interface. You can delete the local copy of the branch with: `git branch -D branch/to-delete-name` | ||
| + | ||
| +**If your PR is rejected** | ||
| + | ||
| +Don't despair! You should receive solid feedback from the Issue Moderators as to why it was rejected and what changes are needed. | ||
| + | ||
| +Many Pull Requests, especially first Pull Requests, require correction or updating. If you have used the GitHub interface to create your PR, you will need to close your PR, create a new branch, and re-submit. This is because you cannot squash your commits via the GitHub interface. | ||
| + | ||
| +If you have a local copy of the repo, you can make the requested changes and amend your commit with: `git commit --amend` This will update your existing commit. When you push it to your fork you will need to do a force push to overwrite your old commit: `git push --force` | ||
| -## Create a Pull Request | ||
| -1. Read our [How to Create a Pull Request for Free Code Camp](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/How-To-Create-A-Pull-Request-for-Free-Code-Camp) | ||
| -2. Submit a [pull request](https://github.com/FreeCodeCamp/FreeCodeCamp/wiki/Pull-Request-Contribute) from your branch to Free Code Camp's `staging` branch. | ||
| - - The title (also called the subject) of your PR should be descriptive of your changes. i.e. `fix typo in basic-javascript challenge` | ||
| - - If the PR is meant to fix a specific issue, append to the end of your PR's commit message `closes #1337`. This tells GitHub to close that issue if the PR is merged. | ||
| - - Do NOT add issue numbers to the PR's title. i.e. `minor improvements in basic-javascript challenge` | ||
| +Be sure to post in the PR conversation that you have made the requested changes. |
97
README.md
0 comments on commit
47d1872