Skip to content

Latest commit

 

History

History
84 lines (62 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

84 lines (62 loc) · 3.58 KB
Raw

Contributing

Thank you for taking the time to contribute to this project. The maintainers greatly appreciate the interest of contributors and rely on continued engagement with the community to ensure that this project remains useful. We would like to take steps to put contributors in the best possible position to have their contributions accepted. Please take a few moments to read this short guide on how to contribute; bear in mind that contributions regarding how to best contribute are also welcome.

Feedback and Questions

If you wish to discuss anything related to the project, please open a GitHub issue.

Contribution Process

Before proposing a contribution via pull request (PR), ideally there is an open issue describing the need for your contribution (refer to this issue number when you submit the pull request). We have a 3 steps process for contributions.

  1. Fork the project if you have not, and commit changes to a git branch
  2. Create a GitHub Pull Request for your change, following the instructions in the pull request template.
  3. Perform a Code Review with the maintainers on the pull request.

Pull Request Requirements

  1. Explain your contribution in plain language. To assist the maintainers in understanding and appreciating your pull request, please use the template to explain why you are making this contribution, rather than just what the contribution entails.

Code Review Process

Code review takes place in GitHub pull requests. See this article if you're not familiar with GitHub Pull Requests.

Once you open a pull request, maintainers will review your code using the built-in code review process in GitHub PRs. The process at this point is as follows:

  1. A maintainer will review your code and merge it if no changes are necessary. Your change will be merged into the repository's main branch.
  2. If a maintainer has feedback or questions on your changes then they will set request changes in the review and provide an explanation.

Using git

For collaboration purposes, it is best if you create a GitHub account and fork the repository to your own account. Once you do this you will be able to push your changes to your GitHub repository for others to see and use, and it will be easier to send pull requests.

Branches and Commits

You should submit your patch as a git branch named after the GitHub issue, such as #3. This is called a topic branch and allows users to associate a branch of code with the issue.

It is a best practice to have your commit message have a summary line that includes the issue number, followed by an empty line and then a brief description of the commit. This also helps other contributors understand the purpose of changes to the code.

    #3 - platform_family and style

    * use platform_family for platform checking
    * update notifies syntax to "resource_type[resource_name]" instead of
      resources() lookup
    * GH-692 - delete config files dropped off by packages in conf.d
    * dropped debian 4 support because all other platforms have the same
      values, and it is older than "old stable" debian release

Release cycle

Main branch is always available. Tagged versions may be created as needed following Semantic Versioning as far as applicable.

This file has been modified from the Chef Cookbook Contributing Guide.