Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 2.07 KB

Contributing to VTS Browser

Melown VTS Browser project openly welcomes contributions (bug reports, bug fixes, code enhancements/features, etc.).
This document will outline some guidelines on contributing to it.

VTS Browser has the following modes of contribution:

  • GitHub Pull Requests (accepted and moderated by contributors with git write access)
  • GitHub Commit Access (granted to long-term core developers)

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct (see CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.

Contributor License Agreement

Contributors are asked to expressly agree with Melown Contributor License Agreement (CLA).

The purpose of the Melown CLA is to ensure that

  • Melown secures copyright and any patent rights necessary to make your code part of the project
  • your contribution does not infringe on other people's rights

You agree with the CLA by

  1. downloading a CLA copy and printing it,
  2. entering your name, your legal address and current date,
  3. signing the document,
  4. scanning the signed document and emailing it to community at melown.com.

This is only required once for your contributions to all Melown repositories.

GitHub Commit Guidelines

  • enhancements and bug fixes should be identified with a GitHub issue
  • commits should be granular enough for other developers to understand the nature / implications of the change(s). You might be asked to merge commits, so that other developers are able to understand commit content.
  • non-trivial git commits shall be associated with a GitHub issue. As documentation can always be improved, tickets need not be opened for improving the docs
  • git commits shall include a description of changes
  • git commits shall include the GitHub issue number (i.e. #1234) in the git commit log message