Skip to content

Latest commit

 

History

History
25 lines (18 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

25 lines (18 loc) · 1.45 KB
Raw

Contributing

Thanks a bunch for wanting to help Zooniverse. Here are few quick guidelines to start working on our project:

Issue

Hey you found something wrong with one of our sites, thanks for taking the time to let us know.

  1. Please be as descriptive as possible.
  2. Include your Browser and Operating System combination.
  3. Screenshots are triple bonus Zoo points.

Pull Requests

Say you have some documentation or code you want to add:

  1. Fork the Project on Github.
  2. Clone the code and follow one of the above guides to setup a dev environment.
  3. Create a new git branch and make your changes.
  4. Make sure the tests still pass by running bundle exec rspec in our Rails projects or npm test in the JavaScript ones.
  5. Add tests if you introduced new functionality.
  6. Commit your changes. Try to make your commit message informative, but we're not sticklers about it. Do try to to add Closes #issue or Fixes #issue somewhere in your message if it's addressing a specific open issue.
  7. Submit a Pull Request (PR)
  8. Wait for feedback or a merge!
  9. If your PR is open for a while, it may get out of synch with the master branch. In that case, pull the latest master branch and run git rebase master – while in your feature branch – to update your feature branch to the latest master. You may need to use git push --force-with-lease to update your PR after rebasing.