From dade24f4d511ab537e141434e896d8824027dd0b Mon Sep 17 00:00:00 2001 From: eecavanna Date: Fri, 20 Dec 2024 17:36:28 -0800 Subject: [PATCH] Add Mermaid diagram depicting Issue-Branch-Develop-PR sequence --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 63f79d6..7557c43 100644 --- a/README.md +++ b/README.md @@ -72,10 +72,21 @@ Its content is organized according to the [Diátaxis](https://diataxis.fr/how-to Here's how you can make (technically, "propose") a change to this section of the website: -> **Note:** The high-level process may be familiar to you: (1) create a GitHub Issue, (2) create a branch associated -> with that Issue, (3) make changes on that branch, and (4) create a Pull Request to merge that branch into `main`. -> You can use whatever workflow you want in order to do those things. The following are some example workflows we've -> documented for our teammates. +**Note:** The high-level process may be familiar to you: (1) create a GitHub Issue, (2) create a branch associated +with that Issue, (3) make changes on that branch, and (4) create a Pull Request to merge that branch into `main`. + +```mermaid +flowchart LR + a("1. Create issue") + b("2. Create branch") + c("3. Make changes on branch") + d("4. Create pull request") + + a --> b --> c --> d +``` + +You can use whatever workflow you want in order to do those things. The following are some example workflows we've +documented for our teammates. #### Basic workflow (to edit 1 file)