Skip to content

Latest commit

 

History

History
112 lines (83 loc) · 4.45 KB

CONTRIBUTING.md

File metadata and controls

112 lines (83 loc) · 4.45 KB
Raw

How to Contribute

In the spirit of open source software, everyone is encouraged to help improve this project.

Ways you can contribute:

  • by installing and testing the software
  • by reporting bugs
  • by suggesting new features
  • by suggesting labels for our issues
  • by writing or editing documentation
  • by writing test specifications
  • by writing code (no patch is too small: fix typos, add comments, clean up inconsistent whitespace)
  • by refactoring code
  • by closing issues
  • by reviewing patches
  • by donating to Code for America

Reporting a bug or other issue

We use the GitHub issue tracker to track bugs and feature requests. To submit a bug report or feature request:

  1. Browse or search our issues to make sure it hasn't already been submitted.

  2. When submitting a bug report, it's helpful to include any details that may be necessary to reproduce the bug, including:

    • a screenshot
    • your operating system (Windows 7, Mac OSX 10.9.2, etc.)
    • your web browser and version (Internet Explorer 9, Chrome 27, etc.)
    • a stack trace of any errors encountered
    • your Ruby version (use ruby -v from the command line)

For developers, a bug report should ideally include a pull request with failing specs.

Updating the Code? Open a Pull Request

To submit a code change to the project for review by the team:

  1. Setup: Install the app on your computer.

  2. Branch: Create a topic branch for the one specific issue you're addressing.

  3. Write Specs: Add specs for your unimplemented feature or bug fix in the /spec/ directory.

  4. Test to fail: Run spring rspec. If your specs pass, return to step 3. In the spirit of Test-Driven Development, you want to write a failing test first, then implement the feature or bug fix to make the test pass.

  5. Implement: Implement your feature or bug fix. Please follow the community-driven Ruby Style Guide*. Note that we follow the single-quote style.

  6. Test to pass: Run script/test to run the test suite, in addition to style checkers. If your specs fail and/or style offenses are reported, return to step 5.

  7. Commit changes: Add, commit, and push your changes.

  8. Pull request: Submit a pull request to send your changes to this repository for review.

*If you use Sublime Text, please make sure to set your tab indentation to 2 spaces. We also highly recommend you use the TrailingSpaces plugin and set it to Trim On Save.

Updating the sample data

This mainly applies to maintainers of this project.

  1. Pull the latest code and run script/bootstrap.
  2. Create a new branch.
  3. Sign in to the admin interface as a super admin.
  4. Make changes.
  5. Export the DB: script/export
  6. Commit the new ohana_api_development.dump, push, and submit a PR.

Pushing updated sample data to the demo and test apps on Heroku

If you have access to the ohana-api-demo and ohana-api-test Heroku apps, you can restore their DBs by following these steps:

  1. Upload ohana_api_development.dump somewhere on the web, such as Amazon S3, and make it readable by everyone.

  2. Restore the DB on Heroku.

For the demo API:

heroku pgbackups:restore HEROKU_POSTGRESQL_TEAL_URL 'url_to_ohana_api_development.dump' -a ohana-api-demo --confirm ohana-api-demo

For the test API:

heroku pgbackups:restore HEROKU_POSTGRESQL_COPPER_URL 'url_to_ohana_api_development.dump' -a ohana-api-test --confirm ohana-api-test

Replace url_to_ohana_api_development.dump with the actual URL to the dump file.