Skip to content

Latest commit

 

History

History
201 lines (132 loc) · 7.37 KB

CONTRIBUTING.md

File metadata and controls

201 lines (132 loc) · 7.37 KB
Raw

Contributing to os_patching

👍🎉 Welcome and thanks for considering contributing to the os_patching module 🎉👍

Below are some instructions to get you started doing that very thing while setting expectations around code quality as well as a few tips for making the process as easy as possible.

Table of Contents

  1. Getting Started
  2. Commit Checklist
  3. Submission
  4. More about commits
  5. Testing
  6. Get Help

Getting Started

  • Fork the module repository on GitHub and clone to your workspace

  • Create a branch for your changes

  • Make your changes!

Commit Checklist

The Basics

  • my commit is a single logical unit of work

  • I have checked for unnecessary whitespace with "git diff --check"

  • my commit does not include commented out code or unneeded files

The Content

  • my commit includes tests for the bug I fixed or feature I added

  • my commit includes appropriate documentation changes if it is introducing a new feature or changing existing functionality

  • my code passes existing test suites

The Commit Message

  • the first line of my commit message includes:

    • an issue number (if applicable), e.g. "(MODULES-xxxx) This is the first line"

    • a short description (50 characters is the soft limit, excluding ticket number(s))

  • the body of my commit message:

    • is meaningful

    • uses the imperative, present tense: "change", not "changed" or "changes"

    • includes motivation for the change, and contrasts its implementation with the previous behavior

Submission

Pre-requisites

Push and PR

More about commits

  1. Make separate commits for logically separate changes.

    Please break your commits down into logically consistent units which include new or changed tests relevant to the rest of the change. The goal of doing this is to make the diff easier to read for whoever is reviewing your code. In general, the easier your diff is to read, the more likely someone will be happy to review it and get it into the code base.

    If you are going to refactor a piece of code, please do so as a separate commit from your feature or bug fix changes.

    We also really appreciate changes that include tests to make sure the bug is not re-introduced, and that the feature is not accidentally broken.

    Describe the technical detail of the change(s). If your description starts to get too long, that is a good sign that you probably need to split up your commit into more finely grained pieces.

    Commits which plainly describe the things which help reviewers check the patch and future developers understand the code are much more likely to be merged in with a minimum of bike-shedding or requested changes. Ideally, the commit message would include information, and be in a form suitable for inclusion in the release notes for the version of Puppet that includes them.

    Please also check that you are not introducing any trailing whitespace or other "whitespace errors". You can do this by running "git diff --check" on your changes before you commit.

  2. Sending your patches

    To submit your changes via a GitHub pull request, we highly recommend that you have them on a topic branch, instead of directly on "master". It makes things much easier to keep track of, especially if you decide to work on another thing before your first change is merged in.

    GitHub has some pretty good general documentation on using their site. They also have documentation on creating pull requests.

    In general, after pushing your topic branch up to your repository on GitHub, you can switch to the branch in the GitHub UI and click "Pull Request" towards the top of the page in order to open a pull request.

  3. Update the related issue.

    If there is an issue associated with the change you submitted, then you should update the ticket to include the location of your branch, along with any other commentary you may wish to make.

Testing

Getting Started

The os_patching module provides Gemfiles, which can tell a Ruby package manager such as bundler what Ruby packages, or Gems, are required to build, develop, and test this software.

Please make sure you have bundler installed on your system, and then use it to install all dependencies needed for this project in the project root by running

% bundle install --path .bundle/gems
Fetching gem metadata from https://rubygems.org/........
Fetching gem metadata from https://rubygems.org/..
Using rake (10.1.0)
Using builder (3.2.2)
-- 8><-- many more --><8 --
Using rspec-system-puppet (2.2.0)
Using serverspec (0.6.3)
Using rspec-system-serverspec (1.0.0)
Using bundler (1.3.5)
Your bundle is complete!
Use `bundle show [gemname]` to see where a bundled gem is installed.

NOTE: some systems may require you to run this command with sudo.

If you already have those gems installed, make sure they are up-to-date:

% bundle update

Running Tests

With all dependencies in place and up-to-date, run the tests:

Validation Tests

% make validate

The validation tests will ensure the metadata and code are syntactically correct and that they meet the style guide. This includes the YAML, JSON, EPP, ERB and ruby files.

Unit Tests

% make unit

This executes all the rspec tests defined in spec/classes. The tests compile catalogs using sample fact sets for each OS listed in the metadata.json file, providing the catalog compiles, it then validates that the resources you've defined are present in the catalog.

rspec tests may have the same kind of dependencies as the module they are testing. Although the module defines these dependencies in its metadata.json, rspec tests define them in .fixtures.yml.

Acceptance Tests

% make acceptance

The module also has acceptance tests, which use litmus. Litmus uses docker to stand up a range of environments, installs the puppet agent, applies the module and then validates that the desired results have been achieved in a single run.

Get Help