Skip to content

Latest commit

 

History

History
63 lines (55 loc) · 2.95 KB

CONTRIBUTING.md

File metadata and controls

63 lines (55 loc) · 2.95 KB
Raw

How to contribute

We want to keep it as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

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 on GitHub

Making Changes

  • Create a topic branch from where you want to base your work.
    • This must be the develop branch.
    • To quickly create a topic branch; git branch fix/my_contribution develop then checkout the new branch with git checkout fix/my_contribution. Please avoid working directly on the master or develop branch.
  • Make commits of logical units.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure your commit messages are in the proper format.
#1234 Make the example in CONTRIBUTING imperative and concrete

Without this patch applied the example commit message in the CONTRIBUTING
document is not a concrete example.  This is a problem because the
contributor is left to imagine what the commit message should look like
based on a description rather than an example.  This patch fixes the
problem by making the example concrete and imperative.

The first line is a real life imperative statement with a ticket number
from our issue tracker.  The body describes the behavior without the patch,
why this is a problem, and how the patch fixes the problem when applied.

Making Trivial Changes

Documentation

For changes of a trivial nature to comments and documentation, it is not always necessary to create a new issue. In this case, it is appropriate to start the first line of a commit with '#doc' instead of a ticket number.

#doc Add documentation commit example to CONTRIBUTING

There is no example for contributing a documentation commit
to the Puppet repository. This is a problem because the contributor
is left to assume how a commit of this nature may appear.

The first line is a real life imperative statement with '#doc' in
place of what would have been the ticket number in a
non-documentation related commit. The body describes the nature of
the new documentation or comments added.

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the repository in the KKoPV organization.

Syntax

  • Four spaces, no tabs
  • No trailing whitespace. Blank lines should not have any space.
  • Prefer AND/OR over &&/||
  • $a = $b and not $a=$b
  • Follow the conventions you see used in the source already.

Additional Resources