Skip to content

Latest commit

 

History

History
96 lines (72 loc) · 4.84 KB

CONTRIBUTING.md

File metadata and controls

96 lines (72 loc) · 4.84 KB

Contributing to cf-release

The Cloud Foundry team uses GitHub and accepts contributions via pull request.

The cf-release repository is a BOSH release for Cloud Foundry.

If you wish to make a change to any of the components, submit a pull request to those repositories directly. Once accepted those changes should make their way into cf-release. All components are submodules in cf-release and can be found in the src/ directory.

If you want to make changes to the cf-release itself, read on.

Contributor License Agreement

Follow these steps to make a contribution to any of our open source repositories:

  1. Ensure that you have completed our CLA Agreement for individuals or corporations.

  2. Set your name and email (these should match the information on your submitted CLA)

git config --global user.name "Firstname Lastname"
git config --global user.email "your_email@example.com"
  1. All contributions should be sent using GitHub "Pull Requests", which is the only way the project will accept them and creates a nice audit trail and structured approach.

The originating github user has to either have a github id on-file with the list of approved users that have signed the CLA or they can be a public "member" of a GitHub organization for a group that has signed the corporate CLA. This enables the corporations to manage their users themselves instead of having to tell us when someone joins/leaves an organization. By removing a user from an organization's GitHub account, their new contributions are no longer approved because they are no longer covered under a CLA.

If a contribution is deemed to be covered by an existing CLA, then it is analyzed for engineering quality and product fit before merging it.

If a contribution is not covered by the CLA, then the automated CLA system notifies the submitter politely that we cannot identify their CLA and ask them to sign either an individual or corporate CLA. This happens automatially as a comment on pull requests.

When the project receives a new CLA, it is recorded in the project records, the CLA is added to the database for the automated system uses, then we manually make the Pull Request as having a CLA on-file.

Proposing new Features

Please see the Proposing New Features page on the Cloud Foundry community wiki that explains the process for getting the team's buy-in on your contribution before you start work.

General Workflow

  1. Collaborate with the team before you start work

  2. Fork the repository and make a local clone

  3. Create a feature branch from the development branch

    cd cf-release
    git checkout develop
    ./update
    git checkout -b better_cf-release
    
  4. Build and deploy the checked out version of cf-release. We recommend using bosh-lite for this.

    cd cf-release
    ./bosh-lite/make_manifest
    
    bosh create release
    bosh upload release
    bosh deploy
  5. Make changes on your branch

  6. Update and run manifest generation tests for each infrastructure with rspec spec

  7. Re-deploy your version of cf-release.

  8. Run Cloud Foundry Acceptance Tests (CATS). We recommend running the tests as a bosh errand (bosh run errand acceptance_tests). You won't see any output from the tests until the errand completes. If you choose to run them manually, please follow the instructions in the CATS README.

  9. Push to your fork (git push origin better_cf-release) and submit a pull request selecting develop as the target branch

We favor pull requests with very small, single commits with a single purpose.

Your pull request is much more likely to be accepted if:

  • Your pull request includes tests. The runtime development team uses test driven development to help ensure high quality code and excellent test coverage.

  • Your pull request is small and focused with a clear message that conveys the intent of your change.