[INFRA] Establish unified project-wide standards (issue #14)#3
Merged
kristopherjturner merged 4 commits intomainfrom Mar 17, 2026
Merged
[INFRA] Establish unified project-wide standards (issue #14)#3kristopherjturner merged 4 commits intomainfrom
kristopherjturner merged 4 commits intomainfrom
Conversation
- Rename configs/ to config/ (org-wide standard: singular) - Rename variables.template.yml to variables.example.yml (org-wide standard) - Move schema assets from config/variables/assets/ to config/schema/ - Rename infrastructure.schema.json to variables.schema.json - Update all path references across scripts, docs, and README - Update .gitignore to match new paths - Add config/variables.yml to .gitignore Resolves AzureLocal/azurelocal.github.io#15
Validates infrastructure.yml against schema and checks variables.example.yml syntax. Part of AzureLocal/azurelocal.github.io#15
- Create PR template with standards compliance checklist - Update CONTRIBUTING.md with links to central standards - Add validate-repo-structure CI workflow
kristopherjturner
added
type/infra
kristopherjturner
added
type/infra
7 tasks
There was a problem hiding this comment.
Pull request overview
Establishes organization-wide contribution/standards guidance and adds CI enforcement to keep the repository aligned with those standards.
Changes:
- Add a PR template with a standards/compliance checklist.
- Update
CONTRIBUTING.mdto link to centralized AzureLocal standards documentation. - Add a GitHub Actions workflow intended to validate required repo structure on PRs.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
CONTRIBUTING.md |
Adds a “Standards” section linking to org-wide standards references. |
.github/workflows/validate-repo-structure.yml |
Introduces a PR-time structure validation workflow (root files/dirs + intended config/doc checks). |
.github/PULL_REQUEST_TEMPLATE.md |
Adds a PR template with testing/checklist + standards compliance items. |
💡 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
+50
to
+59
| - 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" |
Comment on lines
+73
to
+74
| if [ ! -f "docs/reference/variables.md" ]; then | ||
| echo "::error::Missing docs/reference/variables.md (required when config/ exists)" |
| - [ ] Documentation update | ||
| - [ ] Infrastructure / CI change | ||
| - [ ] Refactor (no functional change) | ||
| - [ ] Other: |
…/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
Implements unified project-wide standards for the toolkit repo, per AzureLocal/azurelocal.github.io#14.
Changes
Links