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!
Mobile users: if the page does not load, select menu -> desktop version in your browser.
Cockroach Labs personnel: click "log in" bottom left of this page to authenticate and see other spaces.
The pages on this wiki have not been reviewed for accuracy or suitability for any purpose. The content may not be up-to-date at the moment you access it.
The information presented here is provided on an "as is" basis, without warranties or conditions of any kind, either express or implied, including, without limitation, any warranties or conditions of title, non-infringement, merchantability, or fitness for a particular purpose. You are solely responsible for determining the appropriateness of using or redistributing this information and assume any risks associated with use or redistribution.
Recently Updated Pages
Search this documentation
- Understanding CockroachDB
- Contributing to CockroachDB
- Reporting bugs in CockroachDB
- Evaluate the complexity of your project
- Code reviews
- Productivity Tips
- What is a Good CockroachDB PR
- Getting and building CockroachDB from source
- Engineering standards
- Go (Golang) coding guidelines
- Code commenting guidelines
- Git Commit Messages
- Organizing PRs and Commits
- Updating PRs during review
- Can I still commit/merge code if there is still work left to do?
- Backporting a change to a release branch
- Log and error redactability
- Adding, Updating and Deleting external dependencies
- Marking features as "not yet implemented"
- Guidelines for Cluster Settings, CLI flags and Env vars
- Community Code of Conduct
- Troubleshooting CockroachDB
- Maintaining CockroachDB
- Page Index
- Testing CockroachDB
- Overview of all test frameworks
- TestServer and TestCluster
- Roachtest overview
- Roachtest vs TestServer/TestCluster
- Building and running tests
- How to investigate a Go test failure
- Nightly tests
- Bors Merge Bot
- Code coverage
- TeamCity Continuous Integration (CI)
- How to ensure your tests can run in the Bazel sandbox
- Large scale testing
Copyright (C) Cockroach Labs.
Attention: This documentation is provided on an "as is" basis, without warranties or conditions of any kind, either express or implied, including, without limitation, any warranties or conditions of title, non-infringement, merchantability, or fitness for a particular purpose.