Workflow Overview

Use the following as a quick reference for the general workflow for contributing to Couchbase Documentation.

Contributors from outside Couchbase need to fork documentation repositories to contribute changes. If you’re a Couchbase employee, DO NOT fork repositories to contribute to Couchbase Documentation.

To set up to contribute to Couchbase Documentation, you must:

Clone a repository onto your computer.

To make a contribution or change to Couchbase Documentation, you must:

Review each repository’s requirements.
Choose a base branch.
Create a working branch for your changes.
Fix existing documentation or create a new documentation page.
Build the site locally and test your changes.
Commit and push your changes.
Submit a pull request.
Make requested changes to your pull request.
Merge your pull request.
Delete your working branch.

Always try to delete old, unmerged branches or branches that you have merged with a pull request (PR) when you’re done with them. This keeps our repositories tidy.