mirror of
https://github.com/uber/RIBs.git
synced 2026-06-16 12:54:31 +00:00
James Barr
cb51d73da2
* Integrate Spotless in build * Update CONTRIBUTING.md * Move improperly placed copyright comments * Update copyright indent * Don't format test fixtures * Run spotlessApply over the whole repo * Remove checkstyle configs * Run spotlessCheck on CI
46 lines
2.5 KiB
Markdown
Executable File
46 lines
2.5 KiB
Markdown
Executable File
# Contributing to RIBs
|
|
|
|
Uber welcomes contributions of all kinds and sizes. This includes everything from from simple bug reports to large features.
|
|
|
|
Before we can accept your contributions, we kindly ask you to sign our [Contributor License Agreement](https://cla-assistant.io/uber/RIBs).
|
|
|
|
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, bug fixes, etc are always welcome.
|
|
|
|
### Code style
|
|
|
|
This project uses [ktfmt](https://github.com/facebookincubator/ktfmt), [ktlint](https://github.com/pinterest/ktlint), and [GJF](https://github.com/google/google-java-format),
|
|
provided via the [spotless](https://github.com/diffplug/spotless) gradle plugin.
|
|
|
|
If you find that one of your pull reviews does not pass the CI server check due to a code style
|
|
conflict, you can easily fix it by running: `./gradlew spotlessApply`.
|
|
|
|
Generally speaking - we use ktfmt, vanilla ktlint + 2space indents, and vanilla GJF. You can integrate both of
|
|
these in IntelliJ code style via either [GJF's official plugin](https://plugins.jetbrains.com/plugin/8527-google-java-format) or applying code style from Jetbrains' official style.
|
|
|
|
No star imports please!
|
|
|
|
DOs and DON'Ts
|
|
--------------
|
|
|
|
* DO follow our [coding style](https://github.com/uber/java-code-styles)
|
|
* DO include tests when adding new features. When fixing bugs, start with adding a test 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.
|
|
|
|
Guiding Principles
|
|
------------------
|
|
|
|
* We allow anyone to participate in our projects. Tasks can be carried out by anyone that demonstrates the capability to complete them
|
|
* Always be respectful of one another. Assume the best in others and act with empathy at all times
|
|
* Collaborate closely with individuals maintaining the project or experienced users. Getting ideas out in the open and seeing a proposal before it's a pull request helps reduce redundancy and ensures we're all connected to the decision making process
|