Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You'll notice that all source files in this repository have a license notification at the top. Be sure to copy this license into any files that you create (adjust the year to be the current year).

Are small / trivial changes acceptable?

The CockroachDB team welcomes external contributions. However, please note that we typically do not accept trivial changes to spelling or wording of code comments or error messages unless they are part of larger, more substantial feature improvements or bug fixes, as these small edits can result in additional merge conflicts in ongoing development work.

When to submit

Code at Cockroach Labs is not about perfection. It's too easy to misinterpret "build it right" as "build it perfectly," but striving for perfection can lead to over-engineered code that took longer than necessary to write. Especially as a startup that moves quickly, building it right often means building the simplest workable solution, then iterating as necessary. What we try to avoid at Cockroach Labs is the quick, dirty, gross hack—but even that can be acceptable to plug an urgent leak.

...

So, you've written your code and written your tests. It's time to send your code for slaughter review.

Fix your style violations

...

  • CR, "code review"

  • PR, "pull request"—you probably knew that one.

  • PTAL, "please take another look"

  • RFAL, "ready for another look"—as in, I made some changes, PTAL.

  • LGTM, "looks good to me"—i.e., ship it!

    woman_scientistImage RemoveddogImage Removed

    , "science dog"—i.e., I have no idea what this code does.

  • TF[YT]R, "thanks for your/the review"

...