Azure / Azure/azure-quickstart-templates
Add reference numbers to Azure Resource Manager Templates - Best Practices Guide
- Dominant language
- Bicep
- Stars
- 14.9k
- Forks
- 16.2k
- Avg merge
- 6d 21h
- Merged PRs (30d)
- 6
Description
Specific requirements of the 'Azure Resource Manager Templates - Best Practices Guide' are referenced in PRs that fail validation.
It is difficult to find the section referenced based on the PR text.
https://github.com/Azure/azure-quickstart-templates/blob/master/1-CONTRIBUTION-GUIDE/best-practices.md#best-practices
Please add at least section and paragraph numbers to this document to align with other requirements documents Microsoft uses.
I would also recommend renaming this from 'Best Practices' to 'Requirements' since if they are not followed the submission fails. If not all guidelines are requirements, then each guideline should be more specific to whether it is a guideline or a requirement.
Contributor guide
No contributing guide indexed for this repository
Research direction
Open 1-CONTRIBUTION-GUIDE/best-practices.md and review the Best Practices section referenced by validation-failure PRs. Add section and paragraph numbers so those references are easy to locate, then resolve whether the document should be renamed to Requirements or whether each item should be labeled as a guideline or requirement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100