Contribution guide is contradictory - Githubissues

Azure / Community-Policy

This repo is for Microsoft Azure customers and Microsoft teams to collaborate in making custom policies.

MIT License

636 stars 327 forks source link

Contribution guide is contradictory #281

Closed SebastianClaesson closed 1 year ago

SebastianClaesson commented 1 year ago

Under the section "Files, folders and naming conventions" there's a statement that a Azure policy needs to include 4 different files.

azurepolicy.json
azurepolicy.rules.json
azurepolicy.parameters.json
README.md

There's a description stating

Include a README.md file that explains how the Azure Policy works, and how to assign it at scope.
Guidelines on the README.md file below.

Same under "Pull requests" PR must:

Contain a single Policy (with 4 files)
Requests for changes must be answered within 30 days
- PR will be deleted after this time

However, there's also a section stating that the README.md is optional https://github.com/Azure/Community-Policy/blob/master/CONTRIBUTING.md#readmemd-optional

Is the guideline that the README.md must be included or is it optional?

techlake commented 1 year ago

Optional. We are having a discusion around this topic and will refine the guidance soon.