github.com/sap/cf-mta-plugin@v2.6.3+incompatible/CONTRIBUTING.md (about)

     1  # Contributing to the MultiApps CF CLI Plugin
     2  
     3  ## Did you find a bug?
     4  * Check if the bug has already been reported and has an open [Issue](https://github.com/cloudfoundry-incubator/multiapps-cli-plugin/issues).
     5  
     6  * If there is none, create one by using the provided [Issue Template](https://github.com/cloudfoundry-incubator/multiapps-cli-plugin/issues/new/choose) for bugs.
     7  
     8  * Try to be as detailed as possible when describing the bug. Every bit of information helps!
     9  
    10  ## Do you have a question or need support?
    11  If you need any support or have any questions regarding the project, you can drop us a message on [Slack](https://cloudfoundry.slack.com/?redir=%2Fmessages%2Fmultiapps-dev) or open an [Issue](https://github.com/cloudfoundry-incubator/multiapps-cli-plugin/issues) and we shall get back to you.
    12  
    13  ## Do you want to contribute to the code base?
    14  
    15  ### Starter GitHub Issues
    16  If you are looking for what you can contribute to the project, check the GitHub Issues labeled as [Good First Issue](https://github.com/cloudfoundry-incubator/multiapps-cli-plugin/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) to find items that are marked as more beginner friendly.
    17  
    18  ### Fork the project
    19  * To develop your contribution to the project, first [fork](https://help.github.com/articles/fork-a-repo/) this repository in your own github account.
    20  
    21  * To clone the project into your Go workspace check the [Cloning the repository](https://github.com/cloudfoundry-incubator/multiapps-cli-plugin#cloning-the-repository) section.
    22  
    23  * When developing make sure to keep your fork up to date with the origin's master branch or the release branch you want to contribute a fix to.
    24  
    25  ### How to build, develop and install?
    26  * To build a new version of the plugin follow the [Development](https://github.com/cloudfoundry-incubator/multiapps-cli-plugin#development) instructions.
    27  
    28  * If you have added new dependencies into the CF plugin make sure to update them as described in the [Adding Dependencies](https://github.com/cloudfoundry-incubator//multiapps-cli-plugin#adding-dependency-into-the-multiapps-cli-plugin).
    29  
    30  * To install the plugin follow the [Installation](https://github.com/cloudfoundry-incubator//multiapps-cli-plugin#installation) instructions.
    31  
    32  ### Testing
    33  * Running the tests is done with the [ginkgo](https://github.com/onsi/ginkgo) framework. Once you have it installed just execute `ginkgo -r` from the project's root directory and it will run all the tests.
    34  
    35  * If you are developing new functionality make sure to add tests covering the new scenarios where applicable!
    36  
    37  * The [spring-music](https://github.com/nvvalchev/spring-music) contains a handy sample MTA archive to test your MultiApps CF CLI Plugin against the MultiApps Controller.
    38  
    39  ### Formatting
    40  Having the same style of formatting across the project helps a lot with readability. To format the project's source code run the following command from the root directory of the project:
    41  ```
    42  gofmt -w cli clients commands testutil ui util
    43  ```
    44  
    45  ## Creating a pull request
    46  When creating a pull request please use the provided template. Don't forget to link the [Issue](https://github.com/cloudfoundry-incubator/multiapps-cli-plugin/issues) if there is one related to your pull request!