github.com/leeprovoost/terraform@v0.6.10-0.20160119085442-96f3f76118e7/CONTRIBUTING.md (about)

     1  # Contributing to Terraform
     2  
     3  **First:** if you're unsure or afraid of _anything_, just ask
     4  or submit the issue or pull request anyways. You won't be yelled at for
     5  giving your best effort. The worst that can happen is that you'll be
     6  politely asked to change something. We appreciate any sort of contributions,
     7  and don't want a wall of rules to get in the way of that.
     8  
     9  However, for those individuals who want a bit more guidance on the
    10  best way to contribute to the project, read on. This document will cover
    11  what we're looking for. By addressing all the points we're looking for,
    12  it raises the chances we can quickly merge or address your contributions.
    13  
    14  ## Issues
    15  
    16  ### Reporting an Issue
    17  
    18  * Make sure you test against the latest released version. It is possible
    19    we already fixed the bug you're experiencing.
    20  
    21  * Provide steps to reproduce the issue, along with your `.tf` files,
    22    with secrets removed, so we can try to reproduce it. Without this,
    23    it makes it much harder to fix the issue.
    24  
    25  * If you experienced a panic, please create a [gist](https://gist.github.com)
    26    of the *entire* generated crash log for us to look at. Double check
    27    no sensitive items were in the log.
    28  
    29  * Respond as promptly as possible to any questions made by the Terraform
    30    team to your issue. Stale issues will be closed.
    31  
    32  ### Issue Lifecycle
    33  
    34  1. The issue is reported.
    35  
    36  2. The issue is verified and categorized by a Terraform collaborator.
    37     Categorization is done via tags. For example, bugs are marked as "bugs".
    38  
    39  3. Unless it is critical, the issue is left for a period of time (sometimes
    40     many weeks), giving outside contributors a chance to address the issue.
    41  
    42  4. The issue is addressed in a pull request or commit. The issue will be
    43     referenced in the commit message so that the code that fixes it is clearly
    44     linked.
    45  
    46  5. The issue is closed. Sometimes, valid issues will be closed to keep
    47     the issue tracker clean. The issue is still indexed and available for
    48     future viewers, or can be re-opened if necessary.
    49  
    50  # Contributing to Terraform
    51  
    52  Thank you for contributing! We do have some requests that we ask you to include
    53  in your contribution 
    54  
    55  ## Providers or Resources
    56  
    57  Contributions to Providers or their Resources need to be documented and include
    58  relevant acceptance tests. Information on setting up the terraform.io site
    59  locally can be found in the [website folder][1]
    60  of this repository, in the README. 
    61  
    62  Instructions on how to run acceptance tests can be found in our [README][2]
    63  in the root of this project. 
    64  
    65  If you have questions about this process, please checkout our [mailing list][3]
    66  or #terraform-tool on Freenode.
    67  
    68  ## Setting up Go to work on Terraform
    69  
    70  If you have never worked with Go before, you will have to complete the
    71  following steps in order to be able to compile and test Terraform (or 
    72  use the Vagrantfile in this repo to stand up a dev VM).
    73  
    74  1. Install Go. Make sure the Go version is at least Go 1.4. Terraform will not work with anything less than
    75     Go 1.4. On a Mac, you can `brew install go` to install Go 1.4.
    76  
    77  2. Set and export the `GOPATH` environment variable and update your `PATH`.
    78     For example, you can add to your `.bash_profile`.
    79  
    80      ```
    81      export GOPATH=$HOME/Documents/golang
    82      export PATH=$PATH:$GOPATH/bin
    83      ```
    84  
    85  3. [Follow the development guide](https://github.com/hashicorp/terraform#developing-terraform)
    86  
    87  5. Make your changes to the Terraform source, being sure to run the basic
    88     tests.
    89  
    90  7. If everything works well and the tests pass, run `go fmt` on your code
    91     before submitting a pull request.
    92  
    93  [1]: https://github.com/hashicorp/terraform/tree/master/website
    94  [2]: https://github.com/hashicorp/terraform#acceptance-tests
    95  [3]: https://groups.google.com/group/terraform-tool