flowmade-one/architecture
3
0
Fork 0
Code Issues 15 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

[Issue #5] Add tip about --description vs --body flag for PR creation #9

Merged
HugoNijhuis merged 1 commits from issue-5-tea-description-flag-tip into main 2025-12-31 17:59:26 +00:00
Conversation 3 Commits 1 Files Changed 1 +1
HugoNijhuis commented 2025-12-31 16:18:27 +00:00
Owner
Copy Link

Summary

  • Adds a tip to the gitea skill's Tips section documenting that tea CLI uses --description/-d flag for PR body content, not --body like gh CLI
  • Helps prevent failed commands when users are used to gh CLI syntax

Test plan

  • Verify the tip is correctly placed in the Tips section of skills/gitea/SKILL.md

Closes #5

🤖 Generated with Claude Code

## Summary - Adds a tip to the gitea skill's Tips section documenting that tea CLI uses `--description`/`-d` flag for PR body content, not `--body` like gh CLI - Helps prevent failed commands when users are used to gh CLI syntax ## Test plan - [x] Verify the tip is correctly placed in the Tips section of skills/gitea/SKILL.md Closes #5 🤖 Generated with [Claude Code](https://claude.com/claude-code)
HugoNijhuis added 1 commit 2025-12-31 16:18:28 +00:00
Add tip about --description vs --body flag for PR creation e2198c0d8e 
Documents that tea CLI uses --description/-d flag for PR body content,
not --body like the gh CLI. This helps avoid failed commands when
transitioning from gh CLI.

Closes #5

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
HugoNijhuis commented 2025-12-31 16:25:57 +00:00
Author
Owner
Copy Link

AI Code Review

LGTM - This PR adds a helpful tip documenting that tea CLI uses --description/-d (not --body like gh CLI). Well-placed, concise, and follows the existing documentation pattern.

## AI Code Review **LGTM** - This PR adds a helpful tip documenting that tea CLI uses --description/-d (not --body like gh CLI). Well-placed, concise, and follows the existing documentation pattern.
HugoNijhuis commented 2025-12-31 17:54:15 +00:00
Author
Owner
Copy Link

AI Code Review

This is an automated review generated by the code-reviewer agent.

Summary

Clean documentation improvement that addresses a common usability issue when switching between gh and tea CLIs. The tip is well-formatted, concise, and appropriately placed.

Findings

Code Quality

  • Follows existing documentation formatting conventions perfectly
  • Consistent with other tips in style and structure
  • Concise and actionable wording

Potential Bugs

  • No issues found

Security Concerns

  • No issues found (documentation only)

Style Notes

  • Perfectly consistent with existing tip format
  • Bold label + colon + description matches the pattern established by other tips
  • Appropriate use of backticks for CLI flags

Test Coverage

  • Not applicable (documentation change)
  • PR includes verification checklist in test plan

Verdict

LGTM - Ready to merge. This is a valuable addition that will help users avoid common mistakes when using tea CLI.

## AI Code Review > This is an automated review generated by the code-reviewer agent. ### Summary Clean documentation improvement that addresses a common usability issue when switching between gh and tea CLIs. The tip is well-formatted, concise, and appropriately placed. ### Findings #### Code Quality - Follows existing documentation formatting conventions perfectly - Consistent with other tips in style and structure - Concise and actionable wording #### Potential Bugs - No issues found #### Security Concerns - No issues found (documentation only) #### Style Notes - Perfectly consistent with existing tip format - Bold label + colon + description matches the pattern established by other tips - Appropriate use of backticks for CLI flags #### Test Coverage - Not applicable (documentation change) - PR includes verification checklist in test plan ### Verdict LGTM - Ready to merge. This is a valuable addition that will help users avoid common mistakes when using tea CLI.
HugoNijhuis merged commit e2198c0d8e into main 2025-12-31 17:59:26 +00:00
HugoNijhuis deleted branch issue-5-tea-description-flag-tip 2025-12-31 17:59:27 +00:00
HugoNijhuis commented 2025-12-31 18:00:53 +00:00
Author
Owner
Copy Link

AI Code Review

This is an automated review generated by the code-reviewer agent.

Summary

This PR adds a helpful tip documenting the difference between tea CLI and gh CLI flag naming for PR descriptions. The change is well-placed, concise, and follows the existing documentation pattern.

Findings

Code Quality

  • Clear and actionable tip that follows the established format (bolded term followed by explanation)
  • Placement after the "View single issue" tip maintains logical grouping (both are command syntax clarifications)
  • Parenthetical comparison to gh CLI provides valuable context for users familiar with GitHub's CLI

Potential Bugs

  • No issues found (documentation change only)

Security Concerns

  • No issues found

Style Notes

  • Consistent with existing tip format in the Tips section
  • Uses the same pattern as the first tip (command clarification with "NOT" warning)
  • Proper markdown formatting with bold emphasis

Test Coverage

  • Not applicable for documentation changes
  • The test plan correctly identifies verification of placement in the Tips section

Verdict

LGTM - This is a valuable addition that will prevent user confusion when creating PRs with tea CLI. The tip is correctly formatted, well-placed, and addresses a real usability issue documented in #5.

## AI Code Review > This is an automated review generated by the code-reviewer agent. ### Summary This PR adds a helpful tip documenting the difference between tea CLI and gh CLI flag naming for PR descriptions. The change is well-placed, concise, and follows the existing documentation pattern. ### Findings #### Code Quality - Clear and actionable tip that follows the established format (bolded term followed by explanation) - Placement after the "View single issue" tip maintains logical grouping (both are command syntax clarifications) - Parenthetical comparison to gh CLI provides valuable context for users familiar with GitHub's CLI #### Potential Bugs - No issues found (documentation change only) #### Security Concerns - No issues found #### Style Notes - Consistent with existing tip format in the Tips section - Uses the same pattern as the first tip (command clarification with "NOT" warning) - Proper markdown formatting with bold emphasis #### Test Coverage - Not applicable for documentation changes - The test plan correctly identifies verification of placement in the Tips section ### Verdict **LGTM** - This is a valuable addition that will prevent user confusion when creating PRs with tea CLI. The tip is correctly formatted, well-placed, and addresses a real usability issue documented in #5.
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
HugoNijhuis fluxcd-bot renovate-bot
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: flowmade-one/architecture#9
Delete Branch "issue-5-tea-description-flag-tip"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?