From ac742bf66209b2882232bdab09b8cbe4d002e8f8 Mon Sep 17 00:00:00 2001 From: Neil Cuzon <58763315+NeilCuzon@users.noreply.github.com> Date: Wed, 10 Mar 2021 20:00:14 -0800 Subject: [PATCH] Update development.md --- docs/development.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/development.md b/docs/development.md index 284f23a10..ff4441d97 100644 --- a/docs/development.md +++ b/docs/development.md @@ -8,18 +8,19 @@ Here are a few things to know to get you started on the right path. **All the documents displayed in the github.io page are listed in [sidebar.md](https://github.com/mermaid-js/mermaid/edit/develop/docs/_sidebar.md)** -**Note: You will have to edit the document to see its contents. Commits and PR's should be directed to the develop branch.** +**Note: Commits and Pull Requests should be directed to the develop branch.** ## Branching -Going forward we will use a **Git Flow** inspired approach to branching. So development is done in the `develop` branch. +Mermaid uses a [Git Flow](https://guides.github.com/introduction/flow/) inspired approach to branching. So development is done in the `develop` branch. Once development is done we branch a release branch from develop for testing. -Once the release happens we merge the release branch to master and kill the release branch. +Once the release happens we merge the release branch with master and kill the release branch. This means... **you should branch off your pull request from develop** and direct all Pull Requests to it. + ## Contributing Code We make all changes via pull requests. As we have many pull requests from developers new to mermaid, we have put in place a process, wherein *knsv, Knut Sveidqvist* is the primary reviewer of changes and merging pull requests. It is as follows: