10000 Reinstating Primer Style CLI content within `cli/cli` repository by andyfeller · Pull Request #11060 · cli/cli · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Reinstating Primer Style CLI content within cli/cli repository #11060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 6 commits into from
Jul 5, 2025
Merged

Reinstating Primer Style CLI content within cli/cli repository #11060

merged 6 commits into from
Jul 5, 2025
+596 −2

Conversation

andyfeller
Copy link
Member

This draft pull request is to open a discussion with maintainers and contributors about bringing https://github.com/primer/cli/ content into cli/cli repository.

These design documents formed the basis of how the GitHub CLI was designed and have provided guidance to date. This is a precursor to expanding these docs based upon the work done in v2.72.0 with accessibility enhancements.

@andyfeller
Initial restore of Primer CLI docs
e6cc90a 
This commit brings the https://github.com/primer/cli/ content into the repository for contributors and maintainers.

Minimal changes to the original content have been made as this is being hosted as pure markdown.
@andyfeller
Rename READMEs
a9468ae 
Help content automatically render
@andyfeller
Add missing files
3008aba
@andyfeller
Fix spacing
180f629
@andyfeller
Primer formatting
4ba6d05
@BagToad
Copy link
Member
BagToad commented Jun 2, 2025

Love it! I miss having this resource, so I'm very happy to see it come back in some form, especially one that we can improve more directly.

Some random questions that come to mind:

  • should we decouple this from primer? Wondering if we should rename it to avoid confusion and also take full responsibility of the content.
  • should this be treated as a part of a larger cli/cli style guide that includes design and implementation/code specific guidance. This is a bit of a question hiding as an idea - to me this is a component of a larger engineering guidelines story and it might make sense to ponder how it fits into the big picture.
  • are we changing licenses by republishing it here? I'm not sure with what licensing the original primer CLI docs were under. It probably doesn't matter but it came to mind.
  • do we ever envision this showing up on a GitHub CLI web page like cli.github.com/something? More of a curiosity driven question since I'm not even sure if I want that myself.

@andyfeller andyfeller marked this pull request as ready for review July 2, 2025 15:31
@Copilot Copilot AI review requested due to automatic review settings July 2, 2025 15:31
@andyfeller andyfeller requested a review from a team as a code owner July 2, 2025 15:31
@andyfeller andyfeller requested a review from williammartin July 2, 2025 15:31
Copilot
Copilot AI reviewed Jul 2, 2025
View reviewed changes
Copy link
Contributor
@Copilot 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 reinstates the Primer Style CLI design content into the cli/cli repository, bringing in foundational guidelines that shaped the GitHub CLI’s design and paving the way for expanded accessibility and style documentation.

  • Adds a “Getting Started” primer with core design principles and process steps.
  • Adds a “Foundations” primer covering language, typography, spacing, color, and more.
  • Adds a “Components” primer detailing syntax, prompts, state, and UI patterns.
  • Introduces a top-level docs/primer/README.md linking all primer sections.

Reviewed Changes

Copilot reviewed 4 out of 48 changed files in this pull request and generated 2 comments.

File Description
docs/primer/getting-started/README.md Added core principles, process guidance, and prototyping tips.
docs/primer/foundations/README.md Added foundational design constraints and accessibility notes.
docs/primer/components/README.md Added reusable UI pattern definitions for CLI components.
docs/primer/README.md Added top‐level navigation to primer sections.
Comments suppressed due to low confidence (2)

docs/primer/getting-started/README.md:54

  • The backslash before the asterisk appears unintended and will render a literal '*'. Remove the backslash or rephrase to avoid stray characters.
- Ensure similar commands are visually and behaviorally parallel. \* For example, any create command should behave the same

docs/primer/getting-started/README.md:55

  • Remove the escape before the asterisk to prevent rendering a stray '*', or reword this bullet without the backslash.
- Anticipate what people might want to do next. \* For example, we ask if you want to delete your branch after you merge.

docs/primer/getting-started/README.md
Use [this template](https://docs.google.com/document/d/1JIRErIUuJ6fTgabiFYfCH3x91pyHuytbfa0QLnTfXKM/edit?usp=sharing), or format your document with these steps:

1. Choose a dark background (File > Page Setup > Page Color)
1. Choose a light text color
Copy link
Preview
Copilot AI Jul 2, 2025

Choose a reason for hiding this comment

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

[nitpick] See previous comment: update list numbering to '2.' for this item to reflect sequence.

Copilot uses AI. Check for mistakes.

williammartin
williammartin approved these changes Jul 3, 2025
View reviewed changes
Copy link
Member
@williammartin williammartin left a comment

Choose a reason for hiding this comment

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

Fantastic. No notes.

williammartin
williammartin reviewed Jul 3, 2025
View reviewed changes
Copy link
Member
@williammartin williammartin left a comment

Choose a reason for hiding this comment

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

Well, maybe one note that we might want to link to here from the main README or from CONTRIBUTING.md

@andyfeller
Copy link
Member Author

Well, maybe one note that we might want to link to here from the main README or from CONTRIBUTING.md

praise: good catch! apparently there was a link to the old section within the Primer Style site, so I just updated it to point to these new docs

cli/.github/CONTRIBUTING.md

Lines 53 to 65 in 89f15e9

## Design guidelines
### Proposing a design
You may propose a design to solve an open bug or feature request issue that has both [the `needs-design` and `help-wanted` labels][needs design and help wanted].
To propose a design:
- Open a new issue using the [design proposal issue template](./ISSUE_TEMPLATE/submit-a-design-proposal.md).
- Include a link to the issue that the design is for.
- Describe the design you are proposing to resolve the issue, leveraging the [CLI Design System][].
- Mock up the design you are proposing using our [Google Docs Template][] or code blocks.
- Mock ups should clearly illustrate the command(s) being run and the expected output(s).

@andyfeller andyfeller enabled auto-merge July 5, 2025 18:55
@andyfeller andyfeller merged commit d033770 into trunk Jul 5, 2025
15 checks passed
@andyfeller andyfeller deleted the andyfeller/cli-primer-prototype branch July 5, 2025 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@williammartin williammartin williammartin approved these changes

Copilot code review Copilot Copilot left review comments

Assignees

@andyfeller andyfeller

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@andyfeller @BagToad @williammartin
0