Azure / Azure/bicep

New linting rule - Description metadata

Open
#5,595 1 comment 1 reaction 0 assignees View on GitHub
devdiv enhancement story: linter rules
Dominant language
Bicep
Stars
3.6k
Forks
830
Avg merge
1d 21m
Merged PRs (30d)
79

Description

I'd like the linter to provide warnings where;
**Parameters have been declared with no description metadata**

This would help ensure quality of the bicep code that is produced. It doesn't obviously guarantee good quality descriptions, but as a linting warning it is a good prompt for bicep rookies.

As a natural extension, the other objects that support description metadata should also be able to have this linting rule specified.
Modules/Variables/Resources have been declared with no description metadata

Contributor guide

Open the contributing guide

Research direction

The issue names no files, tests, or entry points; start by locating existing linter rules and the handling of description metadata in the Bicep codebase. Confirm coverage for parameters, modules, variables, and resources, then verify warnings and rule configuration with the relevant linter tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.