Azure / Azure/azure-functions-core-tools

UX: --help audit across all commands and options

Open
#5,351 0 comments 0 reactions 0 assignees View on GitHub
GA v5
Dominant language
C#
Stars
1.5k
Forks
498
Avg merge
5d 4h
Merged PRs (30d)
15

Description

Every command and option must have a clear one-line description
suitable for `--help`. Audit the current surface and fill gaps.

## Definition of Done

- [ ] Every command has a one-line description
- [ ] Every option has a one-line description
- [ ] Test or analyzer guard added to prevent regressions

Contributor guide

Open the contributing guide

Research direction

Start by locating the command and option definitions that provide the `--help` surface, then inspect existing tests or analyzers related to help output. Audit every command and option for a one-line description, and add a test or analyzer guard that catches missing descriptions in future changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
cli, documentation, testing
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.