Skip to content

Latest commit

 

History

History
33 lines (22 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 1.61 KB
Raw

Workflow

This project uses gitflow, here some documentation about how gitflow works

Issues

Bugs, RFE or others should be documented in the issues.

Guidelines

  1. Before opening an issue, search open and closed issues to ensure the issue has not ben reported previously.
  2. Ensure the issue can be reproduced with the latest development version.
  3. The issue should contain detailed instructions and when possible logs, as well as the expected result.
  4. Include details of the environment where it's running, e.g. Debian Jessie, CentOS 7.3, etc.
  5. For RFE explain Why would this feature be useful?

Pull Requests

Code contributions are greatly appreciated, please make sure you follow the guidelines below.

Pull requests should be

  1. Made against the development branch.
  2. Made from a git feature/fix branch.
  3. Associated to a documented issue.

Pull requests will not be accepted that

  1. Are not made against the development branch
  2. Are made by editing files via the GitHub website
  3. Does not have a documented issue for it.

Coding Guidelines

There is no enforcement of a code guideline, as there is no standard for it; this styleguide is to some extent being used, hence recommended. Shell Style Guide.