How to contribute

Third-party patches are essential for keeping Puppet Strings great. 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

Submit an issue

We use GitHub Issues for issue tracking on puppet-strings.

Before you submit your issue, take a minute to…

  1. Use the GitHub issue search — check if the issue has already been reported.

  2. Check if the issue has been fixed — try to reproduce it using the latest main or release tag.

A good bug report shouldn’t leave others needing to chase you up for more information. Please try to be as detailed as possible in your issue. What is your environment? What steps will reproduce the issue?

Example:

Short and descriptive example issue title

A summary of the issue with details about the environment it occurs in (Ruby version, Puppet version, Strings version, etc). If suitable, include the steps required to reproduce the bug.

  1. This is the first step

  2. This is the second step

  3. Further steps, etc.

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

Making Changes

““ (PDOC-123) 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 ticket in Jira. 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

Cutting a release

To cut a new release, from a current main checkout:

Additional Resources