Custom logoCustom icon
Templates
Create

CockroachDB

Overview
Shortcuts
Internal Eng Wiki
CockroachDB Docs
Pages
Understanding CockroachDB
Contributing to CockroachDB
•
Reporting bugs in CockroachDB
Evaluate the complexity of your project
What is a Good CockroachDB PR
Code reviews
Engineering standards
Go (Golang) coding guidelines
•
Code commenting guidelines
Git Commit Messages
•
Decomposing changes and updating PRs during reviews
•
Can I still commit/merge code if there is still work left to do?
•
Marking features as "not yet implemented"
•
Updating Go dependencies
•
Backporting a change to a release branch
•
Log and error redactability
Productivity Tips
Getting and building CockroachDB from source
•
Community Code of Conduct
Testing CockroachDB
Troubleshooting CockroachDB
Maintaining CockroachDB
•
Page Index
  1. CockroachDB
  2. Contributing to CockroachDB
restrictions.empty

Engineering standards

Created by Raphael 'kena' Poss
Oct 11, 2019

  • Go (Golang) coding guidelines
    • Error concepts and handling in CockroachDB
      • Error handling basics
    • Organization of code into packages
    • Go function argument patterns
  • Code commenting guidelines
  • Git Commit Messages
    • Release notes
  • Decomposing changes and updating PRs during reviews
  • Can I still commit/merge code if there is still work left to do?
  • Marking features as "not yet implemented"
  • Updating Go dependencies
  • Backporting a change to a release branch
  • Log and error redactability

{"serverDuration": 45, "requestCorrelationId": "8004a1994ce53e66"}