Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.64 KB

Contribution Guidelines

We love to see contributions to the project and have tried to make it easy to do so. If you would like to contribute code to this project you can do so through GitHub by forking the repository and sending a pull request.

Before Comcast merges your code into the project you must sign the Comcast Contributor License Agreement (CLA).

If you haven't previously signed a Comcast CLA, you'll automatically be asked to when you open a pull request. Alternatively, we can e-mail you a PDF that you can sign and scan back to us. Please send us an e-mail or create a new GitHub issue to request a PDF version of the CLA.

For more details about contributing to GitHub projects see http://gun.io/blog/how-to-github-fork-branch-and-pull-request/

Documentation

If you contribute anything that changes the behavior of the application, document it in the README or wiki! This includes new features, additional variants of behavior and breaking changes.

Testing

Tests are written using golang's standard testing tools, and are run prior to the PR being accepted.

Pull Requests

  • should be narrowly focused with no more than 3 or 4 logical commits
  • when possible, address no more than one issue
  • should be reviewable in the GitHub code review tool
  • should be linked to any issues it relates to (i.e. issue number after (#) in commit messages or pull request message)
  • should conform to idiomatic golang code formatting