github.com/danielqsj/helm@v2.0.0-alpha.4.0.20160908204436-976e0ba5199b+incompatible/CONTRIBUTING.md (about)

     1  # Contributing Guidelines
     2  
     3  The Kubernetes Helm project accepts contributions via GitHub pull requests. This document outlines the process to help get your contribution accepted.
     4  
     5  ## Reporting a Security Issue
     6  
     7  Most of the time, when you find a bug in Helm, it should be reported
     8  using [GitHub issues](github.com/kubernetes/helm/issues). However, if
     9  you are reporting a _security vulnerability_, please email a report to
    10  [helm-security@deis.com](mailto:helm-security@deis.com). This will give
    11  us a chance to try to fix the issue before it is exploited in the wild.
    12  
    13  ## Contributor License Agreements
    14  
    15  We'd love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles.
    16  
    17  Please fill out either the individual or corporate Contributor License Agreement (CLA).
    18  
    19    * If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an [individual CLA](http://code.google.com/legal/individual-cla-v1.0.html).
    20    * If you work for a company that wants to allow you to contribute your work, then you'll need to sign a [corporate CLA](http://code.google.com/legal/corporate-cla-v1.0.html).
    21  
    22  Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.
    23  
    24  ***NOTE***: Only original source code from you and other people that have signed the CLA can be accepted into the main repository.
    25  
    26  ## How to Contribute A Patch
    27  
    28  1. If you haven't already done so, sign a Contributor License Agreement (see details above).
    29  1. Fork the desired repo, develop and test your code changes.
    30  1. Submit a pull request.
    31  
    32  Coding conventions and standards are explained in the official
    33  developer docs:
    34  https://github.com/kubernetes/helm/blob/master/docs/developers.md
    35  
    36  ### Merge Approval
    37  
    38  Helm collaborators may add "LGTM" (Looks Good To Me) or an equivalent comment to indicate that a PR is acceptable. Any change requires at least one LGTM.  No pull requests can be merged until at least one Helm collaborator signs off with an LGTM.
    39  
    40  If the PR is from a Helm collaborator, then he or she should be the one to merge and close it. This keeps the commit stream clean and gives the collaborator the benefit of revisiting the PR before deciding whether or not to merge the changes.
    41  
    42  ## Support Channels
    43  
    44  Whether you are a user or contributor, official support channels include:
    45  
    46  - GitHub issues: https://github.com/kubenetes/helm/issues/new
    47  - Slack: #Helm room in the [Kubernetes Slack](http://slack.kubernetes.io/)
    48  
    49  Before opening a new issue or submitting a new pull request, it's helpful to search the project - it's likely that another user has already reported the issue you're facing, or it's a known issue that we're already aware of.