Skip to content
This repository has been archived by the owner on Dec 27, 2019. It is now read-only.

Latest commit

 

History

History
54 lines (38 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

54 lines (38 loc) · 2.24 KB

How to contribute

If you'd like to help us improve and extend chef-umami, then we welcome your contributions!

Below you will find some basic steps required to be able to contribute to chef-umami. If you have any questions about this process or any other aspect of contributing to a Bloomberg open source project, feel free to send an email to [email protected] and we'll get your questions answered as quickly as we can.

Contribution Licensing

Since chef-umami is distributed under the terms of the Apache License, Version 2.0, contributions that you make to chef-umami are licensed under the same terms. In order for us to be able to accept your contributions, we will need explicit confirmation from you that you are able and willing to provide them under these terms, and the mechanism we use to do this is called a Developer's Certificate of Origin DCO. This is very similar to the process used by the Linux(R) kernel, Samba, and many other major open source projects.

To participate under these terms, all that you must do is include a line like the following as the last line of the commit message for each commit in your contribution:

Signed-Off-By: Random J. Developer <[email protected]>

You must use your real name (sorry, no pseudonyms, and no anonymous contributions).

The Mechanics of Contributing to chef-umami

  1. Fork the repo.
  2. Checkout a new branch.
  3. Open a pull request.

To ensure consistency, all code needs to contain the license header. For convenience, the header can be found at .vim/skeleton/license.skel. For even more convenience, and if one uses vim, use the code in .vimrc at the root of this project. It will ensure that any new files (with the extension .rb) will receive the license header.

To use the .vimrc file in this repo, specify the following in ~/.vimrc:

  set exrc
  set secure

set exrc will enable support for per-project .vimrc meaning vim will find and use the .vimrc in this repo.

set secure will ensure vim doesn't execute autocmd, shell, or write commands unless owned by you.

Alternatively, be diligent about copying the license header into new files.