groombook/app
Archived
13
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add CONTRIBUTING.md with branch strategy (GRO-702) #304

Merged
scrubs-mcbarkley-ceo[bot] merged 2 commits from docs/branch-strategy-contributing into dev 2026-04-16 10:59:16 +00:00
Conversation 4 Commits 2 Files Changed 1
+9 -3
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 4a65c30d40 - Show all commits
CONTRIBUTING.md
+9 -3
View File
@@ -24,7 +24,7 @@ GroomBook uses a three-branch GitOps model:
2. **Open a PR targeting `dev`** — include the issue identifier in the title and cc @cpfarhood:
```bash
gh pr create --base dev --title "feat: description (GRO-NNN)" \
--body "Closes GRO-NNN\n\ncc @cpfarhood"
--body $'Closes GRO-NNN\n\ncc @cpfarhood'
```
greptile-apps[bot] commented 2026-04-16 10:41:46 +00:00 (Migrated from github.com)
Review
Copy Link
Copy Source

P1 \n in double-quoted strings won't produce newlines

In bash, \n inside double quotes ("...") is not interpreted as a newline — it is passed to gh as a literal backslash-n, resulting in a PR body like Closes GRO-NNN\n\ncc @cpfarhood rather than the intended multi-line text. The same issue appears on line 43–44 in the Dev → UAT promotion command.

Use ANSI-C quoting ($'...') so the shell interprets \n before passing the value to gh:

  --body $'Closes GRO-NNN\n\ncc @cpfarhood'

Or the equivalent using printf:

--body "$(printf 'Closes GRO-NNN\n\ncc @cpfarhood')"
Prompt To Fix With AI 
This is a comment left during a code review.
Path: CONTRIBUTING.md
Line: 26-28

Comment:
**`\n` in double-quoted strings won't produce newlines**

In bash, `\n` inside double quotes (`"..."`) is **not** interpreted as a newline — it is passed to `gh` as a literal backslash-n, resulting in a PR body like `Closes GRO-NNN\n\ncc @cpfarhood` rather than the intended multi-line text. The same issue appears on line 43–44 in the Dev → UAT promotion command.

Use ANSI-C quoting (`$'...'`) so the shell interprets `\n` before passing the value to `gh`:

```suggestion
  --body $'Closes GRO-NNN\n\ncc @cpfarhood'
```

Or the equivalent using `printf`:
```bash
--body "$(printf 'Closes GRO-NNN\n\ncc @cpfarhood')"
```

How can I resolve this? If you propose a fix, please make it concise.
<a href="#"><img alt="P1" src="https://greptile-static-assets.s3.amazonaws.com/badges/p1.svg?v=7" align="top"></a> **`\n` in double-quoted strings won't produce newlines** In bash, `\n` inside double quotes (`"..."`) is **not** interpreted as a newline — it is passed to `gh` as a literal backslash-n, resulting in a PR body like `Closes GRO-NNN\n\ncc @cpfarhood` rather than the intended multi-line text. The same issue appears on line 43–44 in the Dev → UAT promotion command. Use ANSI-C quoting (`$'...'`) so the shell interprets `\n` before passing the value to `gh`: ```suggestion --body $'Closes GRO-NNN\n\ncc @cpfarhood' ``` Or the equivalent using `printf`: ```bash --body "$(printf 'Closes GRO-NNN\n\ncc @cpfarhood')" ``` <details><summary>Prompt To Fix With AI</summary> `````markdown This is a comment left during a code review. Path: CONTRIBUTING.md Line: 26-28 Comment: **`\n` in double-quoted strings won't produce newlines** In bash, `\n` inside double quotes (`"..."`) is **not** interpreted as a newline — it is passed to `gh` as a literal backslash-n, resulting in a PR body like `Closes GRO-NNN\n\ncc @cpfarhood` rather than the intended multi-line text. The same issue appears on line 43–44 in the Dev → UAT promotion command. Use ANSI-C quoting (`$'...'`) so the shell interprets `\n` before passing the value to `gh`: ```suggestion --body $'Closes GRO-NNN\n\ncc @cpfarhood' ``` Or the equivalent using `printf`: ```bash --body "$(printf 'Closes GRO-NNN\n\ncc @cpfarhood')" ``` How can I resolve this? If you propose a fix, please make it concise. ````` </details>
3. **Pipeline gates before merge to `dev`:**
@@ -41,7 +41,7 @@ After merging to `dev`, the CTO opens a PR from `dev` → `uat`:
```bash
gh pr create --base uat --head dev \
--title "chore: promote dev to uat (YYYY.MM.DD)" \
--body "Promoting dev to UAT for regression and security review.\n\ncc @cpfarhood"
--body $'Promoting dev to UAT for regression and security review.\n\ncc @cpfarhood'
```
greptile-apps[bot] commented 2026-04-16 10:41:47 +00:00 (Migrated from github.com)
Review
Copy Link
Copy Source

P1 Same \n newline issue in promotion command

Same as the Dev workflow command — \n inside double quotes is a literal backslash-n in bash, not a newline. Fix with ANSI-C quoting:

  --body $'Promoting dev to UAT for regression and security review.\n\ncc @cpfarhood'
Prompt To Fix With AI 
This is a comment left during a code review.
Path: CONTRIBUTING.md
Line: 43-45

Comment:
**Same `\n` newline issue in promotion command**

Same as the Dev workflow command — `\n` inside double quotes is a literal backslash-n in bash, not a newline. Fix with ANSI-C quoting:

```suggestion
  --body $'Promoting dev to UAT for regression and security review.\n\ncc @cpfarhood'
```

How can I resolve this? If you propose a fix, please make it concise.
<a href="#"><img alt="P1" src="https://greptile-static-assets.s3.amazonaws.com/badges/p1.svg?v=7" align="top"></a> **Same `\n` newline issue in promotion command** Same as the Dev workflow command — `\n` inside double quotes is a literal backslash-n in bash, not a newline. Fix with ANSI-C quoting: ```suggestion --body $'Promoting dev to UAT for regression and security review.\n\ncc @cpfarhood' ``` <details><summary>Prompt To Fix With AI</summary> `````markdown This is a comment left during a code review. Path: CONTRIBUTING.md Line: 43-45 Comment: **Same `\n` newline issue in promotion command** Same as the Dev workflow command — `\n` inside double quotes is a literal backslash-n in bash, not a newline. Fix with ANSI-C quoting: ```suggestion --body $'Promoting dev to UAT for regression and security review.\n\ncc @cpfarhood' ``` How can I resolve this? If you propose a fix, please make it concise. ````` </details>
Gates:
@@ -51,7 +51,13 @@ Gates:
### UAT → Main (Production)
After UAT passes, the CTO assigns the promotion PR to the CEO:
After UAT passes, the CTO opens a PR from `uat` → `main` and assigns it to the CEO:
```bash
gh pr create --base main --head uat \
--title "chore: promote uat to main (YYYY.MM.DD)" \
--body $'Promoting UAT to production.\n\ncc @cpfarhood'
```
Gates:
- CEO (Scrubs McBarkley) reviews for business alignment and merges
1