How to submit changes

One gotcha, all pull requests should be directed at the master branch (the default branch).

Code Contributions

Interesting in submitting a pull request? Awesome. Read on. There are a few common gotchas that we’d love to help you avoid.

Tests and documentation

Any time you propose a code change, you should also include updates to the documentation and tests within the same pull request.

Documentation

If your contribution changes any CodeBuild behavior, make sure to update the documentation. Documentation lives in the docs folder. It’s a Jekyll site and can be started with cd docs && bin/web. If the docs are missing information, please feel free to add it in. Great docs make a great project. Include changes to the documentation within your pull request, and once merged, https://cody.run.com will be updated.

Tests

If you’re creating a small fix or patch to an existing feature, a simple test is more than enough. You can usually copy/paste from an existing example in the specs folder.

Code contributions generally

Don’t bump the Gem version in your pull request (if you don’t know what that means, you probably didn’t).

Running tests

Test Dependencies

To run the test suite by running the following command:

bundle exec rspec

Thank You

Thanks! Hacking on CodeBuild should be fun. If you find any of this hard to figure out, let us know so we can improve our process or documentation!

Edit this page

See a typo or an error? You can improve this page. This website is available on GitHub, and contributions are encouraged and welcomed. We love pull requests from you!