The following sections outline the process to contribute to cf-for-k8s.
All members of the cf-for-k8s community must abide by the Code of Conduct. Only by respecting each other can we develop a productive, collaborative community. If you would like to report a violation of the code of contact, please contact any member from the Maintainers list.
We’d love to accept your contributions! But before we can take them, you will have to fill out the EasyCLA.
Once you are CLA’ed, we’ll be able to accept your pull requests.
The cf-for-k8s is maintained by projects that are governed by the Project Management Committee (PMC). Any contribution to cf-for-k8s should be started by first engaging with the appropriate project group. You can find the full list of projects, their leads and contact information here.
Check out preparing for development to learn about how to setup your local dev environment with cf-for-k8s.
If you’re working on an existing issue, simply respond to the issue and express interest in working on it. This helps other people know that the issue is active, and hopefully prevents duplicated efforts.
To submit a proposed change:
When ready, if you have not already done so, sign a contributor license agreement and submit the PR. The PR checks will run unit tests and validate your changes by upgrading from head of develop to your PR, monitoring application uptime whilst doing so. Finally, it will run
smoketests. If there are failures, take a look at the PRs checks, specifically those that failed, and the pipeline output to try and ascertain what went wrong.
Categories of failure might include:
Don’t hesitate to ping the members in #cf-for-k8s slack channel for help.
If you’re looking to get started today, you can explore the good first issue labelled issues in cf-for-k8s repository.
If you’re looking to take on more, you can explore the help wanted labelled issues to get started.
You can create issues to report bugs or submit feature requests. The approporate templates will guide you to fill the key pieces of information. To check for relevant existing issues/reports
In order to contribute a feature to cf-for-k8s, you’ll need to go through the following steps:
First, create a feature request issue type in cf-for-k8s repository. The issue should include information about the requirements and use cases that it is trying to address. Include a discussion of the proposed design and technical details of the implementation in the issue.
If the feature is substantial enough, a project team member may ask for architecture design doc. Create the design document in google doc and add a link to the GitHub issue. Update the projects by sending an email to email@example.com mailing list and/or via slack channel. Depending on the complexity and the breadth of the feature request, the project team may discuss in one of the special interest groups or during runtime PMC meetings or they might directly involve relevant projects before being approved.
Submit PRs to the respective project repository with your code changes. Include relevant documentation changes and tests in your PR.
Note that we prefer bite-sized PRs instead of giant monster PRs. It’s therefore preferable if you can introduce large features in smaller reviewable changes that build on top of one another.
We are very active in slack channel #cf-for-k8s in the Cloud Foundry workspace. Please hit us up with any questions you may have or to share your experience with the cf-for-k8s community. To request a fast reponse during Pacific business hours, begin your message with
Code Of Conduct
Networking Configuration for System Components