Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

56 lines (36 loc) · 2.87 KB
Raw

Contributing to cf-mysql-release

Contributor License Agreement

Follow these steps to make a contribution to any of CF 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"

Branch Workflow

The develop branch is where we do active development. Although we endeavor to keep the develop branch stable, we do not guarantee that any given commit will deploy cleanly.

The release-candidate branch has passed all of our unit, integration, smoke, & acceptance tests, but has not been used in a final release yet. This branch should be fairly stable.

The master branch points to the most recent stable final release.

At semi-regular intervals a final release is created from the release-candidate branch. This final release is tagged and pushed to the master branch.

Pushing to any branch other than develop will create problems for the CI pipeline, which relies on fast forward merges. To recover from this condition follow the instructions here.

Submit a Pull Request

  1. Fork the repository on github

  2. Update submodules (./update)

  3. Create a feature branch (git checkout -b awesome_sauce)

  • Run the unit tests to ensure that your local environment is working ./scripts/test-unit
  1. Make changes on the branch:
  • Adding a feature
    1. Add tests for the new feature
    2. Make the tests pass
  • Fixing a bug
    1. Add a test/tests which exercises the bug
    2. Fix the bug, making the tests pass
  • Refactoring existing functionality
    1. Change the implementation
    2. Ensure that tests still pass
    • If you find yourself changing tests after a refactor, consider refactoring the tests first

  1. Run the acceptance tests (update them if required).

  2. Commit your changes (git commit)

  • Small changes per commit with clear commit messages are preferred.

  1. Push to your fork (git push origin awesome_sauce)

  2. Submit a pull request in github, selecting develop as the target branch.