Skip to content

docs: improve CLI best practices organization in workflow rules#3

Merged
jpke merged 1 commit into
mainfrom
docs/improve-cli-best-practices
Jul 4, 2025
Merged

docs: improve CLI best practices organization in workflow rules#3
jpke merged 1 commit into
mainfrom
docs/improve-cli-best-practices

Conversation

@jpke

@jpke jpke commented Jul 4, 2025

Copy link
Copy Markdown
Owner

This PR improves the organization and comprehensiveness of the CLI best practices section in the workflow rules.

Changes Made:

  • Organized | cat requirements into clear categories (Git commands, GitHub CLI display commands, etc.)
  • Added comprehensive coverage for GitHub CLI commands that weren't previously listed
  • Improved readability and maintainability of the rules
  • Added more specific examples for different command types
  • Enhanced the rule exception section with more clarity

Benefits:

  • Better organization makes the rules easier to follow
  • More comprehensive coverage reduces the chance of missing commands that need | cat
  • Clearer categorization helps developers quickly find relevant commands
  • Improved maintainability for future updates

These changes maintain the same functional requirements while making the documentation more user-friendly and comprehensive.

- Organize | cat requirements into clear categories
- Add comprehensive coverage for GitHub CLI commands
- Improve readability and maintainability of the rules
- Add more specific examples for different command types
@jpke
jpke merged commit 3cada13 into main Jul 4, 2025
7 checks passed
@jpke
jpke deleted the docs/improve-cli-best-practices branch July 4, 2025 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant