github.com/wdesplas/cloud-service-broker@v0.0.0-20211027135251-516a8547ca4c/CONTRIBUTING.md (about) 1 # Contributing to Pivotal Projects 2 3 We’d love to accept your patches and contributions to this project. Please review the following guidelines you'll need to follow in order to make a contribution. 4 5 # Brokerpak Philosophy 6 We anticipate that many of the contributions we receive from the CSB Community will be Brokerpaks which expose new services to operators/developers through the Broker. Our friends at Google have done an awesome job putting together a concise explanation of what a Brokerpak is and the philosophy behind them, check it out [in the docs here.](https://github.com/wdesplas/cloud-service-broker/blob/master/docs/brokerpak-intro.md) 7 8 They've also put together some specifications which we will be aligning to (and modifying as needed). [The specs can be found here.](https://github.com/wdesplas/cloud-service-broker/blob/master/docs/brokerpak-specification.md) 9 10 ## Acceptance Testing 11 12 Please see our files + documentation on [Acceptance Testing](https://github.com/wdesplas/cloud-service-broker/tree/master/acceptance-tests) before you submit a Pull Request. Acceptance testing your code before submitting a Pull Request makes it more likely to be merged with `master` without incident. 13 14 ## Unit + End-to-End Testing 15 Please see our documentation on [Unit + End-to-End Testing](https://github.com/wdesplas/cloud-service-broker/blob/master/TESTING.md) before you submit a Pull Request. Acceptance testing your code before submitting a Pull Request makes it more likely to be merged with `master` without incident. 16 17 ## Code reviews 18 19 All submissions, including submissions by project members, require review and we use GitHub's pull requests for this purpose. Please consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) if you need more information about using pull requests. 20 21 22 ## Contributor License Agreement 23 24 All contributors to this project must have a signed Contributor License Agreement (**"CLA"**) on file with us. The CLA grants us the permissions we need to use and redistribute your contributions as part of the project; you or your employer retain the copyright to your contribution. Head over to https://cla.pivotal.io/ to see your current agreement(s) on file or to sign a new one. 25 26 We generally only need you (or your employer) to sign our CLA once and once signed, you should be able to submit contributions to any Pivotal project. 27 28 Note: if you would like to submit an "_obvious fix_" for something like a typo, formatting issue or spelling mistake, you may not need to sign the CLA. Please see our information on [obvious fixes](https://cla.pivotal.io/about#obvious-fix) for more details. 29 30 31 32 33