Conversation
git guidelines for users and llms
Review Summary by QodoAdd comprehensive Git workflow guide for contributors and LLM agents
WalkthroughsDescription• Add comprehensive Git workflow guide for developers and LLM agents • Define standardized branch naming convention with strict syntax rules • Document development workflow, commit guidelines, and PR requirements • Include advanced Git topics: stash, squash commits, conflict resolution • Establish branch protection and merge strategy best practices Diagramflowchart LR
A["Git Workflow Guide"] --> B["Branch Naming Convention"]
A --> C["Development Workflow"]
A --> D["Commit Rules"]
A --> E["PR Guidelines"]
A --> F["Advanced Topics"]
B --> G["dev_author_type_subject format"]
C --> H["Create branch from main"]
C --> I["Commit and push changes"]
C --> J["Open PR for review"]
F --> K["Stash, Squash, Amend"]
F --> L["Conflict Resolution"]
E --> M["Squash and Merge strategy"]
File Changes1. docs/git_user_and_llm_guide.md
|
Code Review by Qodo
1. Branch naming contradiction
|
![qodo-code-review[bot]](https://avatars.githubusercontent.com/in/484649?s=60&v=4){kind=small}
Co-authored-by: tleyrer <24540697+tleyrer@users.noreply.github.com>
Review Summary by QodoAdd comprehensive Git development workflow guide
WalkthroughsDescription• Comprehensive Git workflow guide for developers and LLM agents • Defines branch naming conventions, commit rules, and PR standards • Includes advanced Git topics like stashing, rebasing, and conflict resolution • Establishes repository hygiene and branch protection requirements Diagramflowchart LR
A["Git Workflow Guide"] --> B["Branch Naming Convention"]
A --> C["Development Workflow"]
A --> D["Commit Rules"]
A --> E["PR Guidelines"]
A --> F["Advanced Topics"]
B --> G["dev_author_type_subject format"]
C --> H["Create branch from main"]
D --> I["Conventional commit messages"]
E --> J["Clear PR descriptions"]
F --> K["Stash, Rebase, Squash"]
File Changes1. docs/git_user_and_llm_guide.md
|
|
Persistent review updated to latest commit be3df51 |
| git commit -m "feat: add PRU instruction self-test framework" | ||
| ``` | ||
|
|
||
| > **Note:** Prefer `git add <specific files>` over `git add .` to avoid accidentally staging untracked or generated files. Use `git status` to review what will be staged. |
There was a problem hiding this comment.
1. Lines exceed 129 columns 📘 Rule violation ⚙ Maintainability
Multiple added documentation lines exceed the 129-column hard limit, reducing readability and violating the repository line-length policy. These lines should be reflowed or reformatted (for example, wrap prose and split wide tables).
Agent Prompt
## Issue description
Several lines in `docs/git_user_and_llm_guide.md` exceed the 129-character hard line-length limit.
## Issue Context
This is documentation content (tables and paragraphs) that can be reformatted without changing meaning.
## Fix Focus Areas
- docs/git_user_and_llm_guide.md[41-46]
- docs/git_user_and_llm_guide.md[144-144]
- docs/git_user_and_llm_guide.md[325-325]
- docs/git_user_and_llm_guide.md[365-365]
- docs/git_user_and_llm_guide.md[490-490]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
nsaulnier-ti
requested changes
Mar 20, 2026
|
|
||
| 1. **Never commit directly to `main`.** (Enforce via branch protection rules — see Section 13.) | ||
| 2. All development must occur in **dedicated branches**. | ||
| 3. Every change must be integrated via a **Pull Request (PR)**. |
Collaborator
There was a problem hiding this comment.
Suggested change
| 3. Every change must be integrated via a **Pull Request (PR)**. | |
| 3. Every change must be integrated into the main branch via a **Pull Request (PR)**. |
| ``` | ||
| git status | ||
| git add <specific files> | ||
| git commit -m "feat: add PRU instruction self-test framework" |
Collaborator
There was a problem hiding this comment.
I prefer git commit -s, which signs the commits with your git ID, and (at least on Linux) opens the git commit message in a text editor to add both the title, and however many paragraph descriptions that you need. I do NOT want to encourage people to only give a title to their commit messages, and no additional context or information.
With that said, apparently you can do git commit -m "title" -m "first paragraph here" -m "second paragraph here". If you wanna document that for LLMs I suppose that is fine, but I would expect a text editor to be easier for an actual human to interact with.
| After approval: | ||
|
|
||
| * PR is merged | ||
| * branch is deleted |
Collaborator
There was a problem hiding this comment.
Note that the OpenPRU repo will not delete your feature branch. We SHOULD document separately that you should delete your feature branch after it is merged though
| docs: update PRU instruction cheat sheet reference | ||
| ``` | ||
|
|
||
| --- |
Collaborator
There was a problem hiding this comment.
I need to pivot to working on other stuff, will try to continue review at 6 later
Co-authored-by: qodo-code-review[bot] <151058649+qodo-code-review[bot]@users.noreply.github.com>
Review Summary by QodoAdd comprehensive Git workflow guide for contributors and LLM agents
WalkthroughsDescription• Comprehensive Git workflow guide for developers and LLM agents • Defines branch naming conventions, commit rules, and PR guidelines • Covers advanced Git topics including stash, rebase, and conflict resolution • Establishes repository hygiene and branch protection standards Diagramflowchart LR
A["Git Workflow Guide"] --> B["Branch Naming Convention"]
A --> C["Development Workflow"]
A --> D["Commit Rules"]
A --> E["PR Guidelines"]
A --> F["Advanced Git Topics"]
A --> G["Repository Standards"]
B --> H["dev_author_type_subject format"]
C --> I["Create branch from main"]
D --> J["Conventional commit messages"]
E --> K["Clear PR descriptions"]
F --> L["Stash, Rebase, Squash"]
G --> M["Branch protection rules"]
File Changes1. docs/git_user_and_llm_guide.md
|
|
Persistent review updated to latest commit 333b858 |
Updated with Nick's feedback and shorten line length
Review Summary by QodoAdd comprehensive Git workflow guide for developers and LLM agents
WalkthroughsDescription• Comprehensive Git workflow guide for developers and LLM agents • Defines branch naming conventions, commit rules, and PR standards • Includes advanced Git topics like stashing, rebasing, and conflict resolution • Establishes repository hygiene and branch protection requirements Diagramflowchart LR
A["Core Principles"] --> B["Branch Naming Convention"]
B --> C["Development Workflow"]
C --> D["Commit Rules"]
D --> E["Pull Request Rules"]
E --> F["Advanced Git Topics"]
F --> G["Conflict Resolution"]
G --> H["Merge Strategy"]
H --> I["LLM Contribution Rules"]
I --> J["Repository Hygiene"]
File Changes1. docs/git_user_and_llm_guide.md
|
|
Persistent review updated to latest commit 56911d1 |
Comment on lines
+5
to
+6
| **Entry points:** This guide is intended to be discovered via the repository’s contributor documentation | ||
| (for example, `docs/contributing.md` and/or `README.md`). If you are reading this in isolation, |
There was a problem hiding this comment.
1. Trailing whitespace in guide 📘 Rule violation ⚙ Maintainability
The new documentation file contains trailing whitespace at the ends of multiple lines, which violates the repository documentation style requirements and can create noisy diffs. Remove trailing spaces to keep formatting consistent and review-friendly.
Agent Prompt
## Issue description
The markdown guide includes trailing whitespace at end-of-line on multiple lines, violating documentation whitespace hygiene rules.
## Issue Context
Trailing whitespace creates noisy diffs and can break style checks.
## Fix Focus Areas
- docs/git_user_and_llm_guide.md[5-6]
- docs/git_user_and_llm_guide.md[134-134]
- docs/git_user_and_llm_guide.md[498-498]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
Updated the branch naming convention section for clarity.
Review Summary by QodoAdd comprehensive Git workflow guide for contributors and LLM agents
WalkthroughsDescription• Comprehensive Git workflow guide for developers and LLM agents • Defines branch naming conventions, commit rules, and PR standards • Includes advanced Git topics like stashing, rebasing, and conflict resolution • Establishes branch protection and merge strategy requirements Diagramflowchart LR
A["Git Workflow Guide"] --> B["Branch Naming Convention"]
A --> C["Development Workflow"]
A --> D["Commit Rules"]
A --> E["PR Guidelines"]
A --> F["Advanced Git Topics"]
B --> G["dev_author_type_subject format"]
C --> H["Create branch from main"]
D --> I["Conventional commit messages"]
E --> J["Clear PR descriptions"]
F --> K["Stash, Rebase, Amend"]
A --> L["LLM Contribution Rules"]
A --> M["Branch Protection Rules"]
File Changes1. docs/git_user_and_llm_guide.md
|
|
Persistent review updated to latest commit 6998087 |
Comment on lines
+32
to
+43
| # 2. Branch Naming Convention | ||
|
|
||
| ## 2. Branch Naming Convention | ||
|
|
||
| To ensure consistency and traceability, all development branches should follow the naming syntax of <author>_<subject>. | ||
| <author> is however you choose to identify yourself, while <subject> is a short description of the change. | ||
|
|
||
| ## Branch Name Format | ||
|
|
||
| ``` | ||
| dev_<author>_<type>_<subject> | ||
| ``` |
There was a problem hiding this comment.
1. Branch naming contradiction 🐞 Bug ✓ Correctness
Section 2 says the naming syntax is <author>_<subject>, but the actual format and examples require dev_<author>_<type>_<subject>, which can lead to nonconforming branches.
Agent Prompt
## Issue description
The branch naming section gives two incompatible formats: a 2-part `<author>_<subject>` description and a 4-part `dev_<author>_<type>_<subject>` format. This is self-contradictory and will confuse contributors.
## Issue Context
All examples in the guide follow the 4-part format, so the 2-part description appears incorrect.
## Fix Focus Areas
- docs/git_user_and_llm_guide.md[32-43]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
CI Feedback 🧐A test triggered by this PR failed. Here is an AI-generated analysis of the failure:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
git guidelines for users and llms.