Workflow Overview

This workflow is for frequent contributors and Couchbase Docs team members who make major changes, add documents, examples, and images, and plan to work on the same set of changes over several days before requesting sign-off.

Workflow Steps

These steps, described under Setting Up Your Workspace, only need to be done once or the first time you plan to contribute to a repository.

Fork the repository into your GitHub account.
Create a clone of the repository on your device.
Connect your local repository with the upstream repository.

Most of the following steps are completed each time you make a contribution to a repository.

Review each repository’s requirements.
Explore the component directory structure.
Choose a base branch.
Create a working branch in Atom or from the command line.
Fix existing documentation or create a new documentation page.
Build the site locally and test your changes.
Commit, rebase, and push your changes.
Submit a pull request.