Note: This repo has no real content, other than this README. Do not file issues or comments here. It simply mirrors our beginner friendly issues to make them discoverable. This guide should help you get started making your first PR!
Puppet uses Jira for most of our issue tracking. This has the unfortunate side effect that the Hacktoberfest filters won't pick them up. This repository mirrors issues so that you can find them. You should use the Jira links to get back to the actual ticket to find more information about it, participate in discussions, or to file your PR.
When you see a Hacktoberfest issue that looks intriguing and within your skillset, you'll want to follow it back to the original Jira ticket. That will have any further discussion and links to other background tickets or other information. You'll use the project name to identify the repository to work in. For example:
Jira Project | Github Repository |
---|---|
PUP |
puppetlabs/puppet |
FACT |
puppetlabs/facter |
PDK |
puppetlabs/pdk |
puppetlabs/pdk-templates |
|
rodjek/rspec-puppet |
|
rodjek/puppet-lint |
|
SERVER |
puppetlabs/puppetserver |
PDOC |
puppetlabs/puppet-strings |
PDB |
puppetlabs/puppetdb |
RK |
puppetlabs/r10k |
TK |
puppetlabs/trapperkeeper |
MODULES |
various repositories named puppetlabs/puppetlabs-<modulename> |
As you're getting into the codebase, you might run into things that don't make sense. Or you might need a little help understanding the architecture, or the execution model. In any case the community is here to help you out!
master
branch.
git checkout -b <a_name_for_your_contribution> master
master
branch.git diff --check
before committing.(PUP-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.
Ready for Merge
.This document is streamlined to cover the common use case of the beginner friendly issues only. It doesn't cover other edge cases, such as targeting a release branch, all-in-one vendor packaging, or any other advanced use cases. Please see the complete CONTRIBUTING.md for more information.