Skip to content
This repository has been archived by the owner on Nov 30, 2021. It is now read-only.

Latest commit

 

History

History
50 lines (36 loc) · 3.88 KB

CONTRIBUTING.md

File metadata and controls

50 lines (36 loc) · 3.88 KB
Raw

Welcome to CockroachDB’s Hacktoberfest Project!

CockroachDB is participating in Hacktoberfest 2020 as a Community Partner. We invite you to contribute to CockroachDB regardless of your database or open source experience. You can work on code or documentation issues, or contribute apps to our sample apps repository. Whether you’re a new or experienced developer or tech writer, a seasoned contributor or new to open source, there’s something for everyone!

What is Hacktoberfest?

Hacktoberfest is a month-long celebration of open source software organized by DigitalOcean, Intel, and DEV. Open four or more high-quality pull requests in October in any public repositories to get a limited edition Hacktoberfest T-shirt!

What is CockroachDB?

CockroachDB is the distributed SQL database built to scale fast, survive anything, and thrive everywhere. Whether you are a single-person startup or a global enterprise, CockroachDB was designed to make managing data easy. To learn more about CockroachDB, see our website and docs.

CockroachDB Hacktoberfest 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 tech writers and docs enthusiasts Help improve CockroachDB docs: List of good first issues Docs contribution guide

How to participate?

  1. Sign up on the Hacktoberfest website.
  2. Look for issues in our code, docs, and app repos with the label Hacktoberfest and assess the difficulty level that you’re keen to undertake.
  3. Find an issue that looks interesting. For Docs and CockroachDB code, add a comment (“taking up this issue”) to the issue so other participants know the issue isn’t available anymore. For the sample app repo, it’s okay if multiple folks open PRs for the same issue. Y’all can make different versions of the same app idea!
  4. Open a PR!

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.

Contribute to CockroachDB

We welcome contributions outside of Hacktoberfest as well. 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.