Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

48 lines (31 loc) · 1.7 KB

Contributing to Dotfiles Boshrelease

We utilize Github Issues for issue tracking and contributions. You can contribute in two ways:

Reporting an issue or making a feature request here. Adding features or fixing bugs yourself and contributing your code.

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 Rakuten,Inc.

  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]"

General Workflow

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

  1. Fork the repository

  2. Update submodules (git submodule update --init)

  3. Create a feature branch from develop(git checkout -b better)

  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. Push to your fork (git push origin better_bosh) 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 is small and focused with a clear message that conveys the intent of your change.