Skip to content
This repository has been archived by the owner on Jan 25, 2023. It is now read-only.

Latest commit

 

History

History
45 lines (28 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 1.06 KB

Contribution Guidelines

  • Please submit improvements and bug fixes via Github pull requests or by sending an email to [email protected] in git's format-patch format.

  • All patches should have well-written commit message. The first line should summarize the change while the rest of the commit message should explain the reason the change is needed.

  • Please ensure all tests and lint checking pass before submitting pull requests.

Development

Requirements

Development Flow

  1. Clone the git repository from GitHub:

     git clone [email protected]:stevendanna/logrotate.git

  2. Ensure you have ChefDK installed:

     chef --version

  3. Create a branch for your changes:

     git checkout -b my_bug_fix

  4. Make any changes

  5. Write tests to support those changes. It is highly recommended you write both unit and integration tests.

  6. Run the tests:

    • make travis
    • kitchen test

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