Azure / Azure/bicep

[LinterRuleIdea] Rule to enforce description on parameters

Open
#9,453 1 comment 1 reaction 0 assignees View on GitHub
enhancement good first issue story: linter rules
Dominant language
Bicep
Stars
3.6k
Forks
830
Avg merge
1d 2h
Merged PRs (30d)
79

Description

**Is your feature request related to a problem? Please describe.**
When developing module library you may want to enforce that all parameters have a description

**Describe the solution you'd like**
I'd like for linter to enforce such rule.

Contributor guide

Open the contributing guide

Research direction

No file, test, or entry point is named. Start by locating the Bicep linter rule implementations and existing rules for parameter metadata; determine how missing descriptions are reported and add focused coverage. Done means the rule reliably identifies parameters without descriptions and behaves consistently with other linter rules.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.