Skip to content

Latest commit

 

History

History
76 lines (58 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

76 lines (58 loc) · 3.52 KB
Raw

Contributing to Mediathread

We'd love for you to contribute to our source code and to make Mediathread even better than it is today! Here are the guidelines we'd like you to follow:

Code of Conduct

Help us keep Mediathread open and inclusive. Please read and follow our Code of Conduct.

Got a Question or Problem?

If you have questions about how to use Mediathread, please direct these to the Google Group.

Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub issue tracker. Even better you can submit a Pull Request with a fix 😍.

Please see the Submission Guidelines below.

Getting Started

  • Make sure you have a GitHub account
  • Submit a ticket for your issue, assuming one does not already exist.
    • Clearly describe the issue including steps to reproduce when it is a bug.
    • Make sure you fill in the earliest version that you know has the issue.
  • Fork the repository into your account on GitHub

Coding Rules

To ensure consistency throughout the source code, please keep these rules in mind as you are working:

  • All features or bug fixes must be tested by one or more unit tests.
  • We follow the conventions contained in:
  • The master branch is continuously integrated by Travis-CI, and all tests must pass before merging.

Making Trivial Changes

Documentation

For changes of a trivial nature to comments and documentation, it is not always necessary to create a new github issue or sign a contributor agreement.

Making Changes

  • Create a topic branch from where you want to base your work.
    • This is usually the master branch.
    • Only target release branches if you are certain your fix must be on that branch.
    • To quickly create a topic branch based on master; git checkout -b fix/master/my_contribution master. Please avoid working directly on the master branch.
  • Create your patch, including appropriate test cases.
  • Make commits of logical units.
  • Run make jenkins to make sure the code passes all validation, flake8, eslint and unit tests
  • Make sure your commit messages are in the proper format.

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the repository in the ccnmtl organization.
  • The core team reviews Pull Requests on a regular basis, and will provide feedback

Further Information

For more information, see: