Skip to content
This repository has been archived by the owner on Jun 2, 2022. It is now read-only.

Latest commit

 

History

History
99 lines (69 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

99 lines (69 loc) · 3.08 KB
Raw

Contributing to the Marathon Cookbook

The Marathon cookbook uses GitHub to triage, manage, and track issues and pull requests to the cookbook. GitHub has excellent documentation on how to fork a repository and start contributing.

All contributors are welcome to submit patches, but we ask you keep the following guidelines in mind:

Please also keep in mind:

  • Be patient as not all items will be tested or reviewed immediately by the core team.
  • Be receptive and responsive to feedback about your additions or changes. The core team and/or other community members may make suggestions or ask questions about your change. This is part of the review process, and helps everyone to understand what is happening, why it is happening, and potentially optimizes your code.
  • Be understanding.

If you're looking to contribute but aren't sure where to start, check out the open issues.

Will Not Merge

This second details Pull Requests that we will not merge.

  1. New features without accompanying Test Kitchen tests
  2. New features without accompanying usage documentation

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.

Prerequisites

In order to run the Test Kitchen integration suite, you must also have Vagrant and VirtualBox installed:

Process

  1. Clone the git repository from GitHub:

     $ git clone git@github.com:mdsol/marathon_cookbook.git

  2. Install ChefDK for your platform:

     $ https://docs.chef.io/install_dk.html

  3. Create a branch for your changes:

     $ git checkout -b my_bug_fix

  4. Make any changes

  5. Write tests to support those changes.

  6. Run the tests:

     $ bundle exec rake

  7. Assuming the tests pass, open a Pull Request on GitHub

Do's and Don't's

  • Do include tests for your contribution
  • Do NOT break existing behavior (unless intentional)
  • Do NOT modify the version number in the metadata.rb
  • Do NOT modify the CHANGELOG