[INFRA] Establish unified project-wide standards (issue #14)#6
Merged
Conversation
Rewrite reference/variables.md with full sectioned YAML format matching config/variables.example.yml. Add naming rules, Key Vault resolution, and tool-specific mapping sections. Replace standards page with redirect. Part of AzureLocal/azurelocal.github.io#15
Add config/schema/variables.schema.json for validating variables.example.yml. Add CI workflow that validates example config against schema on PR. Part of AzureLocal/azurelocal.github.io#15
- Replace docs/standards/ content with links to central standards - Update CONTRIBUTING.md with links to central standards - Add standards compliance checklist to PR template - Add validate-repo-structure CI workflow
kristopherjturner
added
type/infra
7 tasks
There was a problem hiding this comment.
Pull request overview
Consolidates this repo’s local standards documentation to point at the org-wide standards site (azurelocal.cloud/standards), and adds lightweight compliance gates in contribution guidance, PR templates, and CI.
Changes:
- Replace multiple
docs/standards/*pages with short “moved” stubs that link to the canonical central standards. - Add central-standards links to
CONTRIBUTING.mdand a “Standards Compliance” checklist to the PR template. - Introduce a CI workflow intended to validate expected repo structure on pull requests.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/standards/solutions.md | Replaced detailed local standards with a stub linking to the central solution development standard. |
| docs/standards/scripts.md | Replaced detailed local scripting standards with a stub linking to central scripting standards. |
| docs/standards/index.md | Refocused the standards index to central standards with a quick-links table. |
| docs/standards/examples.md | Replaced detailed local example standards with a stub linking to the fictional company policy. |
| docs/standards/documentation.md | Replaced detailed local documentation standards with a stub linking to central documentation standards. |
| CONTRIBUTING.md | Adds a “Standards” section with links to central standards pages. |
| .github/workflows/validate-repo-structure.yml | Adds PR-time validation checks for required files/dirs and config/doc structure. |
| .github/pull_request_template.md | Adds a “Standards Compliance” checklist section. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Comment on lines
+44
to
+45
| if [ ! -f ".github/PULL_REQUEST_TEMPLATE.md" ]; then | ||
| echo "::error::Missing .github/PULL_REQUEST_TEMPLATE.md" |
Comment on lines
+50
to
+64
| - name: Check config structure (if config dir exists) | ||
| run: | | ||
| if [ -d "config" ]; then | ||
| missing=0 | ||
| if [ ! -f "config/variables.example.yml" ]; then | ||
| echo "::error::Missing config/variables.example.yml" | ||
| missing=$((missing + 1)) | ||
| fi | ||
| if [ ! -f "config/schema/variables.schema.json" ]; then | ||
| echo "::error::Missing config/schema/variables.schema.json" | ||
| missing=$((missing + 1)) | ||
| fi | ||
| if [ $missing -gt 0 ]; then | ||
| exit 1 | ||
| fi |
Comment on lines
+1
to
+10
| name: Validate Repo Structure | ||
| on: | ||
| pull_request: | ||
| branches: [main] | ||
|
|
||
| jobs: | ||
| check-structure: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 |
…/issue-14-unified-standards
This was referenced Mar 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Consolidates AVD repo standards to reference the central standards at azurelocal.cloud/standards, per AzureLocal/azurelocal.github.io#14.
Changes
Links