Skip to content

Fix unclear terminology in add command help text#3699

Merged
pelikhan merged 2 commits intomainfrom
copilot/fix-add-command-terminology
Nov 12, 2025
Merged

Fix unclear terminology in add command help text#3699
pelikhan merged 2 commits intomainfrom
copilot/fix-add-command-terminology

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Nov 12, 2025

The add command used ambiguous phrasing "from the components" in its short description. Changed to "from repositories" for clarity and consistency with the long description.

Changes

  • pkg/cli/add_command.go: Updated Short field from "Add one or more workflows from the components to .github/workflows" to "Add workflows from repositories to .github/workflows"

Impact

- Short: "Add one or more workflows from the components to .github/workflows",
+ Short: "Add workflows from repositories to .github/workflows",

Help output now displays:

add         Add workflows from repositories to .github/workflows

Terminology is now consistent with the long description and clearer to users.

Original prompt

This section details on the original issue you should resolve

<issue_title>[cli-consistency] Unclear terminology in add command: "from the components" should be "from repositories"</issue_title>
<issue_description>## Issue Description

Command: gh aw add
Type: Unclear terminology in help text
Priority: Low (minor clarity issue)

Problem

The add command's short description uses the phrase "from the components" which is unclear and potentially confusing.

Current Help Text (pkg/cli/add_command.go):

Short: "Add one or more workflows from the components to .github/workflows",

Issue

  • "from the components" is ambiguous - what are "the components"?
  • The Long description says "from repositories" which is clearer
  • Documentation refers to "The Agentics collection" or "repositories"

Suggested Fix

Make the short description clearer and consistent with the long description:

- Short: "Add one or more workflows from the components to .github/workflows",
+ Short: "Add one or more workflows from repositories to .github/workflows",

Or, even shorter:

- Short: "Add one or more workflows from the components to .github/workflows",
+ Short: "Add workflows from repositories to .github/workflows",

This aligns with the Long description which already says "from repositories".

File to Modify

  • pkg/cli/add_command.go (line 3 in NewAddCommand function)

AI generated by CLI Consistency Checker</issue_description>

Comments on the Issue (you are @copilot in this section)

@pelikhan use shorter version

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Change "from the components" to "from repositories" for clearer terminology.
Use shorter, more concise phrasing as requested.

Fixes issue: unclear terminology in add command help text

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix unclear terminology in add command help text Fix unclear terminology in add command help text Nov 12, 2025
Copilot AI requested a review from pelikhan November 12, 2025 06:40
@pelikhan pelikhan marked this pull request as ready for review November 12, 2025 06:57
Copilot AI review requested due to automatic review settings November 12, 2025 06:57
@pelikhan pelikhan merged commit 70fde77 into main Nov 12, 2025
72 of 75 checks passed
@pelikhan pelikhan deleted the copilot/fix-add-command-terminology branch November 12, 2025 06:58
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR improves the clarity and consistency of the add command's help text by replacing ambiguous terminology. The short description now uses "from repositories" instead of the unclear phrase "from the components", making it consistent with the long description and easier for users to understand.

  • Updated the short help text to use clearer, more accurate terminology
  • Improved consistency between short and long command descriptions

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

[cli-consistency] Unclear terminology in add command: "from the components" should be "from repositories"

3 participants