Getting Started With Contributing

Code Standards

Be sure to check out the code standards before making any contributions.

Git Branching and Features

Firstly, issue tracking and project management for this API is located in the Projects tab. We will be using the master branch in this repository as the deploy for http://api-dev.library.amnh.org; all development will merge into a dev branch, which will become this repo's default. When you create a new branch for your development, the naming convention for that branch should start with label of the issue it is addressing, followed by a slash, then the ID of the issue, a dash, and a short underscore separated description of it.

Example: feature/12-add_number_of_results

Pull Requests

Please do not directly merge anything into develop branch (and NEVER into master branch); instead please create a pull request for your new branch and another contributor will review it.