Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

46 lines (29 loc) · 3.17 KB
Raw

Contributing to the MultiApps CF CLI Plugin

Did you find a bug?

  • Check if the bug has already been reported and has an open Issue.

  • If there is none, create one by using the provided Issue Template for bugs.

  • Try to be as detailed as possible when describing the bug. Every bit of information helps!

Do you have a question or need support?

If you need any support or have any questions regarding the project, you can drop us a message on Slack or open an Issue and we shall get back to you.

Do you want to contribute to the code base?

Starter GitHub Issues

If you are looking for what you can contribute to the project, check the GitHub Issues labeled as Good First Issue to find items that are marked as more beginner friendly.

Fork the project

  • To develop your contribution to the project, first fork this repository in your own github account.

  • To clone the project into your Go workspace check the Cloning the repository section.

  • 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.

How to build, develop and install?

  • To build a new version of the plugin follow the Development instructions.

  • If you have added new dependencies into the CF plugin make sure to update them as described in the Adding Dependencies.

  • To install the plugin follow the Installation instructions.

Testing

  • Running the tests is done with the ginkgo framework. Once you have it installed just execute ginkgo -r from the project's root directory and it will run all the tests.

  • If you are developing new functionality make sure to add tests covering the new scenarios where applicable!

  • The spring-music contains a handy sample MTA archive to test your MultiApps CF CLI Plugin against the MultiApps Controller.

Formatting

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:

gofmt -w cli clients commands testutil ui util

Creating a pull request

When creating a pull request please use the provided template. Don't forget to link the Issue if there is one related to your pull request!