Skip to content

Commit 11d5599

Browse files
kristopherjturnerkristopherjturner
committed
feat: GitHub Project & Repo Standardization (Plan 1)
- Add issue templates (bug, feature, docs, config) and PR template - Add CODEOWNERS, CONTRIBUTING, LICENSE, CHANGELOG - Add release-please config and workflow - Add label sync workflow (sync-labels.yml) - Add project management structure with plans, labels, and repo standard - Add .github/CODEOWNERS
1 parent 565ee92 commit 11d5599

27 files changed

Lines changed: 3047 additions & 0 deletions

‎.github/CODEOWNERS‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# CODEOWNERS - Azure Local Docs Site
2+
# These owners will be automatically requested for review on PRs.
3+
# See: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
4+
5+
# Default owners for everything in the repo
6+
* @kristopherjturner

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Bug Report
3+
about: Report a problem with this project
4+
title: '[BUG] '
5+
labels: type/bug
6+
assignees: ''
7+
---
8+
9+
## Environment
10+
11+
| Field | Value |
12+
|-------|-------|
13+
| **Azure Local version** | e.g. 23H2, 22H2 |
14+
| **Node OS** | e.g. Windows Server 2025 |
15+
| **PowerShell version** | `$PSVersionTable.PSVersion` |
16+
17+
## What happened?
18+
19+
<!-- Describe what you ran and what went wrong -->
20+
21+
## Expected behavior
22+
23+
<!-- What did you expect to happen? -->
24+
25+
## Error message
26+
27+
```
28+
Paste the full error message here
29+
```
30+
31+
## Steps to reproduce
32+
33+
1.
34+
2.
35+
3.
36+
37+
## Relevant log output
38+
39+
```
40+
Paste log output here
41+
```
42+
43+
## Additional context
44+
45+
<!-- Any other relevant details: cluster topology, configuration, screenshots, etc. -->

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Azure Local Documentation
4+
url: https://azurelocal.cloud
5+
about: Visit the main Azure Local documentation site

‎.github/ISSUE_TEMPLATE/docs_issue.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Documentation
3+
about: Report missing, incorrect, or unclear documentation
4+
title: '[DOCS] '
5+
labels: type/docs
6+
assignees: ''
7+
---
8+
9+
## Page or Section
10+
11+
<!-- URL or path to the doc page with the issue -->
12+
13+
## What's Wrong or Missing?
14+
15+
<!-- Describe the documentation gap or error -->
16+
17+
## Suggested Improvement
18+
19+
<!-- Optional: how would you improve it? -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an improvement or new capability
4+
title: '[FEATURE] '
5+
labels: type/feature
6+
assignees: ''
7+
---
8+
9+
## Summary
10+
11+
<!-- A clear, one-sentence description of what you want -->
12+
13+
## Problem / Use Case
14+
15+
<!-- What problem does this solve? What scenario requires this? -->
16+
17+
## Proposed Solution
18+
19+
<!-- How would you like to see this implemented? -->
20+
21+
## Alternatives Considered
22+
23+
<!-- Any other approaches you've thought about? -->
24+
25+
## Additional Context
26+
27+
<!-- Screenshots, links, references, or any other relevant information -->

‎.github/pull_request_template.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## Summary
2+
3+
<!-- What does this PR do? One paragraph max. -->
4+
5+
## Related Issue
6+
7+
Closes #<!-- issue number -->
8+
9+
## Type of Change
10+
11+
- [ ] Bug fix
12+
- [ ] New feature / enhancement
13+
- [ ] Documentation update
14+
- [ ] Infrastructure / CI change
15+
- [ ] Refactor (no functional change)
16+
- [ ] Other:
17+
18+
## Testing Done
19+
20+
<!-- How did you test this? What environment, configuration, and scenarios? -->
21+
22+
## Checklist
23+
24+
- [ ] I have tested this in a non-production environment
25+
- [ ] I have updated the README or `docs/` if usage changed
26+
- [ ] I have added an entry to `CHANGELOG.md` under `[Unreleased]`
27+
- [ ] My code follows the project's style guidelines in `CONTRIBUTING.md`
28+
- [ ] My commit messages follow [Conventional Commits](https://www.conventionalcommits.org/)

‎.github/workflows/release-please.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Release Please
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
permissions:
9+
contents: write
10+
pull-requests: write
11+
12+
jobs:
13+
release-please:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: googleapis/release-please-action@v4
17+
with:
18+
token: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/sync-labels.yml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Sync Labels
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- 'project_management/labels.yml'
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
13+
jobs:
14+
sync:
15+
runs-on: ubuntu-latest
16+
strategy:
17+
matrix:
18+
repo:
19+
- AzureLocal/azurelocal-sofs-fslogix
20+
- AzureLocal/aurelocal-avd
21+
- AzureLocal/azurelocal-loadtools
22+
- AzureLocal/azurelocal-vm-conversion-toolkit
23+
- AzureLocal/azurelocal.github.io
24+
steps:
25+
- uses: actions/checkout@v4
26+
- uses: EndBug/label-sync@v2
27+
with:
28+
config-file: project_management/labels.yml
29+
repository: ${{ matrix.repo }}
30+
token: ${{ secrets.LABEL_SYNC_TOKEN }}
31+
delete-other-labels: false

‎.release-please-manifest.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
".": "0.0.0"
3+
}

‎CHANGELOG.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
6+
7+
## [Unreleased]
8+
9+
### Features
10+
11+
- Docusaurus 3.7.0 community portal at azurelocal.cloud
12+
- Blog engine with authors and tags
13+
- Versioned documentation (1.0.0, 2.0.0)
14+
- Project management hub for cross-repo planning
15+
16+
### Infrastructure
17+
18+
- GitHub Pages deployment via GitHub Actions
19+
- Vale linting with Microsoft style rules
20+
- Add issue and PR templates
21+
- Add CONTRIBUTING.md and LICENSE

0 commit comments

Comments
 (0)