From 931fe855eec027eb5e411d141e41c375722469fc Mon Sep 17 00:00:00 2001 From: Amruta Ranade Date: Wed, 16 Dec 2020 13:10:09 -0500 Subject: [PATCH] Update contributing.md Removed hacktoberfest content + added K8s operator content --- CONTRIBUTING.md | 35 ++++++++++------------------------- 1 file changed, 10 insertions(+), 25 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7db1e36ade5a..2d503a382915 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,36 +1,15 @@ -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](https://hacktoberfest.digitalocean.com/) 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](https://www.cockroachlabs.com/) and [docs](https://www.cockroachlabs.com/docs/stable/). - -## CockroachDB Hacktoberfest projects +## CockroachDB Projects Suitable for | Project | Resources -------------|---------|------------ For new developers | [Create a to-do app using CockroachDB and a language/ORM of your choice](https://github.com/cockroachdb/cockroachdb-todo-apps) | [How to contribute to the to-do apps repository](https://github.com/cockroachdb/cockroachdb-todo-apps#how-to-contribute-to-this-repository) For Go developers | Work on CockroachDB code: [List of good first issues](https://github.com/cockroachdb/cockroach/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) | [Your first CockroachDB PR](https://wiki.crdb.io/wiki/spaces/CRDB/pages/181633464/Your+first+CockroachDB+PR) +For Kubernetes enthusiasts | Work on the Kubernetes Operator: [List of good first issues](https://github.com/cockroachdb/cockroach-operator/labels/good%20first%20issue) | [Your first CockroachDB PR](https://wiki.crdb.io/wiki/spaces/CRDB/pages/181633464/Your+first+CockroachDB+PR) For tech writers and docs enthusiasts | Help improve CockroachDB docs: [List of good first issues](https://github.com/cockroachdb/docs/issues?q=is%3Aopen+is%3Aissue+label%3Agood-first-issue) | [Docs contribution guide](https://github.com/cockroachdb/docs/wiki#using-github-desktop) -## How to participate? - -1. Sign up on the [Hacktoberfest website](https://hacktoberfest.digitalocean.com/). -2. Look for issues in our [code](https://github.com/cockroachdb/cockroach), [docs](https://github.com/cockroachdb/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! +## Contributor Guidelines -## Don’t Forget to Join our Community -Join our [Community Slack](https://cockroa.ch/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](https://docs.google.com/document/d/1_BB3IrsAVglDNPy37Z6KQlii_c3fYETFlWMMBUpbY1M/edit#) 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). +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: @@ -48,3 +27,9 @@ regarding: - how to troubleshoot certain issues as well as many other practical topics. + +## Don’t Forget to Join our Community +Join our [Community Slack](https://cockroa.ch/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](https://docs.google.com/document/d/1_BB3IrsAVglDNPy37Z6KQlii_c3fYETFlWMMBUpbY1M/edit#) to help us make the CockroachDB community a welcoming and helpful place for everyone. +