contributing.md

Contributing

Create an issue

Create an issue describing the motivation for your changes. Are you fixing a bug? Improving documentation? Optimizing some slow code?

Pull Requests without associated Issues may still be accepted, if the motivation is obvious. However, this will help speed up code review if there's any uncertainty.

Change the code

Create a fork and make your code changes. Fix code formatting and run the unit tests with:

./validate.sh

Add tests

All pull requests must have 90% coverage in the changed code. Check the code coverage with:

./scripts/coverage.sh --html

Bugfixes should include a regression test which prevents that bug from being re-introduced in the future.

Update Documentation

Documentation for the project is stored in the docs directory. If your feature requires docs updates, those updates must be submitted in the same Pull Request as the code changes.

• docs/endpoints describes the Prebid Server API. For example, the endpoint host:port/openrtb2/auction is described by docs/endpoints/openrtb2/auction.md
• docs/developers contains docs intended for Developers. These assume that the reader is technical, and describe the mechanics of features.

Open a Pull Request

When you're ready, submit a Pull Request against the master branch of our GitHub repository.

Pull Requests will be vetted through Travis CI. To reproduce these same tests locally, do:

./validate.sh --nofmt --cov

If the tests pass locally, but fail on your PR, update your fork with the latest code from master.

Note: We also have some known intermittent failures. If the tests still fail after pulling master, don't worry about it. We'll re-run them when we review your PR.