Design principles for `gp` cli
Open
Nobody has claimed this yet.
component: gp cli
meta: never-stale
team: IDE
- Dominant language
- TypeScript
- Stars
- 13.8k
- Forks
- 1.4k
- Avg merge
- 17h 58m
- Merged PRs (30d)
- 5
Description
We could do with a set of design principles for gp CLI and/or any resultant clean-up to the API surface.
e.g. topics of:
<subject> <verb>- What lives top-level, etc.
Relates to:
- https://github.com/gitpod-io/gitpod/issues/10449
- Internal conversation regarding
gp infoandgp urldifferences.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the gp CLI entry points and the related issue 10449, then review the linked internal conversation about gp info and gp url. Define the CLI design principles and identify any API-surface cleanup that follows; done means the principles and resulting scope are agreed.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, cli, developer-experience
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100