CONTRIBUTING.md

Contributing to cf-riak-cs-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 "[email protected]"
   

3. 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 tests to ensure that your local environment is working ./scripts/test_submodules

   4. 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

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

   6. Commit your changes (git commit)

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

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

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