Skip to content

Latest commit

 

History

History
66 lines (44 loc) · 4.47 KB

CONTRIBUTING.md

File metadata and controls

66 lines (44 loc) · 4.47 KB
Raw

Contributing

We'd love to have you join our group of contributors! Please e-mail your areas of interest and your availability to contributing@code.org, and we’ll be happy to match you with a project.

This project adheres to the Contributor Covenant. By participating, you are expected to honor this code.

You can start setting up with these next steps:

  1. Anyone who would like to contribute to Code.org projects must read and sign the Contributor License Agreement. We can't accept pull requests from contributors who haven't yet signed the CLA.

  2. Get your local development build working by following our SETUP. Fork our repo and make sure to merge our staging branch into yours WEEKLY as we do update frequently.

Code Style

Please make sure your code conforms to our style guide. We have implemented linting to help you with this:

  • To ensure our precommit linting hook is installed, run rake install:hooks. You should only have to do this once.
  • To lint the entire project, run rake lint from the repository root. This will check all Ruby, JavaScript and HAML.
  • To lint only part of the project, run one of these commands from the repository root:
    • dashboard: cd dashboard && rubocop && haml-lint
    • pegasus Ruby: cd pegasus && rubocop
    • pegasus HAML: haml-lint pegasus
    • apps: See the apps README

Testing

Please test your changes before submitting them to us!

Manual testing

We support recent versions of Firefox, Chrome, Edge, iOS Safari and the Android browsers (full list of supported browsers and versions). Be sure to try your feature out in iOS and Android if it's a risk. Sauce Labs lets you run manual tests in these browsers remotely.

Unit tests

For dashboard changes, be sure to test your changes using rake test. For apps or blockly changes, see our grunt testing instructions.

UI tests

Our continuous integration server regularly runs a suite of UI tests using Selenium / Cucumber which run against many browsers via Sauce Labs, and can also be run locally using chromedriver. See the README in that folder for instructions.

If your changes might affect level paths, blockly UI, or critical path site logic, be sure to test your changes with a local UI test.

Submitting your Pull Request

Once you've linted and tested your changes, send us a pull request! Contributors should follow the GitHub fork-and-pull model to submit pull requests into this repository. Code.org developers should also work on a branch and use a pull request to merge to staging; please do not merge directly to the code-dot-org/staging branch.

  1. On your fork, you'll either push to your own finished branch or checkout a new branch for your feature before you start your feature
    • git checkout -b branch_name
  2. Develop the new feature and push the changes to your fork and branch
    • git add YYY
    • git commit -m "ZZZ"
    • git push origin branch_name
  3. Go to the code-dot-org GitHub page
  4. For your submission to be reviewed
    • Click on the "Pull Request" link, look over and confirm your diff
    • Submit a pull request for your branch to be merged into staging
    • For bonus points, include before and after screenshots in the description. Command + Ctrl + Shift + 4 in OS X lets you copy a screen selection to your clipboard, which GitHub will let you paste right into the description
  5. A Code.org developer will ensure our test suite runs on your changes and will merge your PR to staging for you.
  6. After your pull request is merged into staging, you can review your changes on the following sites: