Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

55 lines (40 loc) · 1.77 KB
Raw

Contributing to the prometheus Cookbook

The prometheus cookbook uses Github to triage, manage, and track issues and changes to the cookbook.

Everybody is welcome to submit patches, but we ask you keep the following guidelines in mind:

Coding Standards

The submitted code should be compatible with the standard Ruby coding guidelines. Here are some additional resources:

This cookbook is equipped with Rubocop, which will fail the build for violating these standards.

Testing

Whether your pull request is a bug fix or introduces new classes or methods to the project, we kindly ask that you include tests for your changes. Even if it's just a small improvement, a test is necessary to ensure the bug is never re-introduced.

We understand that not all users are familiar with the testing ecosystem. This cookbook is fully-tested using Foodcritic, Rubocop, and Test Kitchen with Serverspec bussers.

Process

  1. Clone the git repository from GitHub:

     $ git clone [email protected]:rayrod2030/chef-prometheus.git

  2. Make sure you have a sane ChefDK development environment:

     $ chef version

  3. Make any changes

  4. Write tests to support those changes.

  5. Run the tests:

     $ kitchen verify

  6. Assuming the tests pass, commit your changes