Skip to content

Doc: Recommend and exemplify using 'gh' CLI alongside ContextVibes #12

@duizendstra

Description

@duizendstra

As a ContextVibes CLI user, I want clear documentation and examples on how to effectively use the GitHub CLI ('gh') in conjunction with ContextVibes CLI commands for a complete development workflow (especially for issue tracking and Pull Request management).

Tasks:

  • Review existing ContextVibes CLI documentation (README.md, CONTRIBUTING.md, COMMAND_REFERENCE.md, and potentially a new WORKFLOW_GUIDES.md).
  • Identify places where integrating gh commands would naturally fit into user workflows. Examples:
    • After contextvibes kickoff for daily branches, how to find relevant issues to work on using gh issue list.
    • When using contextvibes commit, how to best reference GitHub issue numbers in commit messages.
    • After contextvibes sync, how to use gh pr create to submit changes.
    • How gh issue develop can be an alternative to contextvibes kickoff for starting work on a specific issue.
  • Add clear, concise examples of these combined workflows.
  • Ensure the guidance emphasizes that gh is a complementary tool, not replaced by ContextVibes for GitHub-specific interactions.

Acceptance Criteria:

  • Relevant sections in existing (or new) documentation are updated with clear guidance and examples for using gh with contextvibes.
  • Users can understand how to combine both tools for efficient issue tracking and PR management.

Metadata

Metadata

Assignees

Labels

docsImprovements or additions to documentationdocumentationImprovements or additions to documentationenhancementNew feature or requestgood first issueGood for newcomersv0.2.0

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions