Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

35 lines (26 loc) · 2.28 KB

CockroachDB Projects

Suitable for Project Resources
For new developers Create a to-do app using CockroachDB and a language/ORM of your choice How to contribute to the to-do apps repository
For Go developers Work on CockroachDB code: List of good first issues Your first CockroachDB PR
For Kubernetes enthusiasts Work on the Kubernetes Operator: List of good first issues Your first CockroachDB PR
For tech writers and docs enthusiasts Help improve CockroachDB docs: List of good first issues Docs contribution guide

Contributor Guidelines

Our contributor guidelines are available on [the public wiki at wiki.crdb.io(https://wiki.crdb.io/wiki/spaces/CRDB/pages/73204033/Contributing+to+CockroachDB).

At this location, we share our team guidelines and knowledge base regarding:

  • repository layout
  • how to build from source
  • how to organize your code change
  • commenting guidelines
  • commit message guidelines
  • code style guidelines
  • how to write and run tests
  • how to write release notes
  • how to submit a change for review
  • how to use continuous integration (CI)
  • how to troubleshoot certain issues

as well as many other practical topics.

Don’t Forget to Join our Community

Join our Community Slack (there's a dedicated #contributors channel!) to ask questions, discuss your ideas, or connect with other contributors.

Please follow the guidelines outlined in our Code of Conduct to help us make the CockroachDB community a welcoming and helpful place for everyone.