Skip to content

Latest commit

 

History

History
26 lines (17 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

26 lines (17 loc) · 1.12 KB
Raw

Contributing to okbuck

The Uber team welcomes contributions of all kinds, from simple bug reports through documentation, test cases, bugfixes, and features.

Workflow

We love GitHub issues!

For small feature requests, an issue first proposing it for discussion or demo implementation in a PR suffice.

For big features, please open an issue so that we can agree on the direction, and hopefully avoid investing a lot of time on a feature that might need reworking.

Small pull requests for things like typos, bugfixes, etc are always welcome.

DOs and DON'Ts

  • DO follow our coding style (https://github.com/uber/okbuck#code-style)

  • DO include integration tests when adding new features. When fixing bugs, start with adding an example that highlights how the current behavior is broken.

  • DO keep the discussions focused. When a new or related topic comes up it's often better to create new issue than to side track the discussion.

  • DON'T submit PRs that alter licensing related files or headers. If you believe there's a problem with them, file an issue and we'll be happy to discuss it.