Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (23 loc) · 1001 Bytes

CONTRIBUTING.md

File metadata and controls

36 lines (23 loc) · 1001 Bytes

Contributing

Thanks for taking a look. This repo is meant to stay clean, portable, and safe to share publicly.

Ground rules

  • No secrets, no IDs: keep placeholders like <SUBSCRIPTION_ID> and REPLACE-WITH-SERVICE-CONNECTION.
  • Keep all code comments in English.
  • Prefer small, focused PRs.

Style & structure

  • Bicep modules live under bicep/**/modules.
  • Parameter files follow parameters.<region>.json.
  • Scripts live in scripts/ and should support -WhatIf where possible.

Testing changes

Before proposing changes, validate locally:

az bicep build --file ./bicep/part1-platform/main.bicep
az bicep build --file ./bicep/part3-devcenter/main.bicep

For deployments, run What-If first (see docs/DEPLOYMENT.md).

Portfolio-safe content

If your change introduces:

  • environment-specific names
  • real network ranges
  • tenant/subscription identifiers

…then it does not belong in this public repo. Put it into a private fork instead.