Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

56 lines (36 loc) · 2.05 KB
Raw

Contributing

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Quick start

After you clone your forked repo, follow the following steps to bootstrap your local environment:

» yarn
» (cd workspaces/homepage && yarn dev)

Code organization

This template is a monorepo. It consists of a number of packages that all live under the workspaces folder.

Workspaces

Confluenza Monorepo Template provides two demo workspaces - demo-workspace-1 and demo-workspace-2 - and homepage. The homepage workspace is the workspace containing your project landing page and documentation browser.

homepage

This is a Gatsby site that uses gatsby-theme-confluenza. Thus, it is still a regular Gatsby site, so you can do whatever Gatsby supports. New to Gatsby? Visit Gatsby website.

demo-workspace-1 and demo-workspace-2

Demonstration workspaces to show that Confluenza makes it easy to make the documentation of every workspace accessible.

Installing dependencies

We install all mono-repo dependencies with single top-level yarn.

Staying in sync with upstream

You can follow the steps described in Syncing a fork. We recommend that you keep your local master branch pointing to the upstream master branch. Remaining in sync then becomes really easy:

git remote add upstream https://github.com/confluenza/monorepo-template.git
git fetch upstream
git branch --set-upstream-to=upstream/master master

Now, when you do git pull from your local master branch git will fetch changes from the upstream remote. Then you can make all of your pull request branches based on this master branch.

Submitting a Pull Request

Please go through existing issues and pull requests to check if somebody else is already working on it, we use someone working on it label to mark such issues.