CockroachDB

Welcome to the CockroachDB wiki space!

This space is meant for technical documentation and guides specifically for contributors to CockroachDB itself.

See also:

• CockroachDB code repository: https://github.com/cockroachdb/cockroach
• Cockroach Labs web site: https://www.cockroachlabs.com/

Note: This is a public space!

Recently Updated Pages

Search this documentation

• Understanding CockroachDB
  • CockroachDB Release Cycle
  • Database Background
  • Jargon: CockroachDB words for newcomers
  • SQL Syntax↔semantics Menagerie
  • Code Labs
    • Codelab: SQL↔KV hacking
    • [draft] SQL Code Lab: Add the STEP statement modifier
• Contributing to CockroachDB
  • Reporting bugs in CockroachDB
  • Evaluate the complexity of your project
    • Low-complexity projects
    • Medium-complexity projects
    • High-complexity projects
  • What is a Good CockroachDB PR
    • Your first CockroachDB PR
  • Code reviews
    • Submitting your contribution
    • Working as a reviewer
    • What to expect when you're expecting (someone to review your code at CRL)
  • Engineering standards
    • Decomposing changes and updating PRs during reviews
    • Git Commit Messages
      • Release notes
    • Code commenting guidelines
    • Marking features as "not yet implemented"
    • Updating Go dependencies
    • Backporting a change to a release branch
    • Go (Golang) coding guidelines
      • Error concepts and handling in CockroachDB
        • Error handling basics
      • Organization of code into packages
      • Go function argument patterns
    • Can I still commit/merge code if there is still work left to do?
    • Log and error redactability
  • Productivity Tips
    • Multiple GOPATHs
    • Ben's Go Emacs Setup
    • Radu's vim setup
    • Git diff side by side
    • Rando scripts
    • CLA Assistant glitch in PRs
    • Using ccache to speed up builds
  • Getting and building CockroachDB from source
    • Building from source on macOS
    • How to ensure your code builds with Bazel
• Testing CockroachDB
  • TeamCity Continuous Integration
  • Bors Merge Bot
  • Large scale testing
  • Building and running tests
  • Nightly tests
  • Code coverage
  • Benchmarking RocksDB
  • How to ensure your tests can run in the Bazel sandbox
• Troubleshooting CockroachDB
  • Profiling CockroachDB
  • Tracing logs with Jaeger and Zipkin
  • Execution tracing a SQL query
  • Debugging with Delve
  • Collecting a "debug zip" manually
  • Using viewcore to analyze core dumps
• Maintaining CockroachDB
  • GitHub Issue Labels
• Page Index