Azure / Azure/Azure-Verified-Modules

[Question/Feedback]: A specs for coding guidelines (SHOULD)

Open
#1,548 1 comment 1 reaction 0 assignees View on GitHub
Needs: Core Team :genie: Needs: Triage :mag: Type: Documentation :page_facing_up:
Dominant language
PowerShell
Stars
580
Forks
161
Avg merge
11h 3m
Merged PRs (30d)
15

Description

### Check for previous/existing GitHub issues

- [x] I have checked for previous/existing GitHub issues

### Description

For example
- You shall use ShallowMerge() over Union() if you are conditionally not allowed to provide a property in a properties block (as opposed to providing empty/null)
- You shall not pass defaults into child modules if they already have defaults defined
- You shall put the import statement of a type on top of a parameter's description not below, as it will otherwise mess up your template
- ...

Contributor guide

No contributing guide indexed for this repository

Research direction

No file, test, or entry point is named. Start by reviewing the existing issue discussion and the repository’s module standards, then define the scope of the proposed SHOULD guidelines. Done means an agreed specification documents rules such as ShallowMerge() versus Union(), child-module defaults, and import placement.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.