Contributor Guidelines

In order to minimize confusion, sos-collector will follow the same contributor guidelines as the main sos project does.

Submitting Pull Requests

• Commit messages should be split over multiple lines where necessary and are (with the exception of e.g. long command, log, or other output that should be included verbatim) hard-wrapped at 72 characters.

• Please write clear commit subjects and messages

  • The subject should make it clear what the patch changes for e.g.:

    [sosnode] Fix SSH error handling

    is preferred over:

    Fix SSH error handling

  • Commits that affect a single component should be tagged with the component name in brackets in the subject line, for e.g.:

    [ovirt] Add Datacenter filtering support

  • Include any issues the code fixes (e.g. Closes: #1) on a separate line

  • If working around python or other external behavior describe this in the full commit message

• Each developer should fork sos-collector into their accounts repository.

  • Not required, but advisable to use [feature/patch][0] branches when working with new code.

• All pull requests should be against master branch

• We avoid merge commits in master so branches may need to be rebased over the master-du-jour prior to merging

• All commits must be accompanied by a Signed-off-by: Firstname Lastname <[email protected]>

  • <email at example dot com> and other obfuscations are fine too.
  • Use git commit -s to automatically add a Signed-off-by with your configured git user details.

• Make sure you are following pep8 style guidelines