Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 2.03 KB

Contributing to the Ohana API Documentation

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

Ways you can contribute:

Reporting a documentation issue

We use the GitHub issue tracker to track bugs. To submit a report:

  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.)

Updating the Code? Open a Pull Request

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

  1. Setup: Install the code on your computer.

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

  3. Implement: Implement your bug fix.

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

  5. 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.