[INFRA] Establish unified project-wide standards (issue #14)#58
Merged
Conversation
Merge naming rules and compatibility section from standards/variables.md into reference/variables.md. Replace standards page with redirect. deployment/variables.md was already a redirect - unchanged. 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
Contributor
There was a problem hiding this comment.
Pull request overview
Consolidates this repo’s local “standards” documentation into lightweight stubs that point to the org-wide canonical standards site (azurelocal.cloud/standards), and introduces repo-structure compliance checks in PR process/CI.
Changes:
- Replaces most
docs/standards/*.mdpages with “moved to central standards” stubs + updatesdocs/standards/index.mdto provide quick links. - Updates
CONTRIBUTING.mdand the PR template to reference central standards and add a “Standards Compliance” checklist. - Adds a GitHub Actions workflow to validate required repo files/directories and config/doc structure on PRs.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/standards/solutions.md | Replaced detailed IaC standards with a stub linking to the central standard. |
| docs/standards/scripts.md | Replaced detailed scripting standards with a stub linking to central standards. |
| docs/standards/index.md | Reworked to a “quick links” hub pointing at central standards + repo-specific notes. |
| docs/standards/examples.md | Replaced example standards with a stub linking to the fictional company policy. |
| docs/standards/documentation.md | Replaced detailed documentation standards with links to central standards. |
| CONTRIBUTING.md | Adds a “Standards” section with key links to central standards. |
| .github/workflows/validate-repo-structure.yml | New CI job that enforces repo-structure requirements on PRs. |
| .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
+58
to
+60
| if [ ! -f "config/schema/variables.schema.json" ]; then | ||
| echo "::error::Missing config/schema/variables.schema.json" | ||
| missing=$((missing + 1)) |
…/issue-14-unified-standards
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 SOFS repo standards to reference the central standards at azurelocal.cloud/standards, per AzureLocal/azurelocal.github.io#14.
Changes
Links