The Cloud Foundry team uses GitHub and accepts code contributions via pull requests.
Follow these steps to make a contribution to any of our open source repositories:
- If your contribution includes a change that is exposed to cf CLI users (e.g. introducing a new command or flag), please submit an issue to discuss it first.
- If you have not previously done so, please fill out and submit the Contributor License Agreement.
- Fork the project’s repository and add a remote (e.g.
git remote add my_fork ...) - Create a feature branch (e.g.
git checkout -b my_cool_feature) and make changes on your branch - Build the plugin, run the tests, and check that the plugin works as intended when installed
- Push to your fork (e.g.
git push my_fork my_cool_feature) and submit a pull request
If you have a CLA on file, your contribution will be analyzed for product fit and engineering quality prior to merging.
Notes:
- All contributions need to be sent using GitHub Pull Requests, preferably consisting of a single commit
- Tests are required for any changes
- We favor small pull requests with a single clearly-defined purpose
- Your pull request is much more likely to be accepted if it has a clear log message which conveys the intent of your change