Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 2.05 KB

Contributing

Welcome, and thanks for lending a hand! Before we get started, please read the Couchbase Code of Conduct.

Discussion

We'd love for you to join us on the Couchbase Forum. For more interactive discussions we have #java, #scala and #kotlin channels on our Discord.

Reporting Issues

The simplest way to help is to report bugs or request new features.

We use Jira for issue tracking. There's a Jira project for each JVM client, and one for the common core-io library:

To create an issue, or comment on an existing issue, you'll need to sign up for an account. It's quick and painless (or if it's not, click on the "Report a problem" link on the signup page or get in touch via the forum).

Pull Requests

We use Gerrit for code review. The GitHub repo is a read-only mirror of the version in Gerrit.

We acknowledge Gerrit can be intimidating for new users. We're considering alternates that will make it easier for GitHub natives to contribute.

You can start by submitting a pull request to the GitHub repo. A bot will comment on your PR and prompt you to register for a Gerrit account and sign a Contributor License Agreement (CLA).

  1. Visit https://review.couchbase.org and register for an account.
  2. Review our Contributor Licence Agreement (CLA).
  3. Agree to the CLA by visiting https://review.couchbase.org/settings/#Agreements Otherwise, you won't be able to push changes to Gerrit (instead getting a "Upload denied for project" message).

If you need any help along the way, please contact us on the Couchbase Forum.