Skip to content

Commit 9aa924e

Browse files
kristopherjturnerkristopherjturner
authored
Merge pull request #3 from AzureLocal/feature/docs-restructure
feat: GitHub Project & Repo Standardization (Plan 1)
2 parents e31127a + 5df58c9 commit 9aa924e

12 files changed

Lines changed: 307 additions & 0 deletions

‎.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/add-to-project.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Add to Project
2+
3+
on:
4+
issues:
5+
types: [opened]
6+
pull_request:
7+
types: [opened]
8+
9+
jobs:
10+
add-to-project:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/add-to-project@v1
14+
with:
15+
project-url: https://github.com/orgs/AzureLocal/projects/3
16+
github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}

‎.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 }}

‎.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: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
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+
- VMFleet, fio, iPerf3, HammerDB, and stress-ng load testing tooling
12+
- Modular PowerShell framework with core and infrastructure modules
13+
- Monitoring collectors, dashboards, and alert rules
14+
- Report templates for performance analysis
15+
16+
### Infrastructure
17+
18+
- Add GitHub Actions workflows for docs, testing, and CI
19+
- Add issue and PR templates
20+
- Add CONTRIBUTING.md

‎CONTRIBUTING.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to the Azure Local Load Tools project. Contributions are welcome — especially around testing with different workload profiles, Azure Local configurations, and performance benchmarking tools.
4+
5+
## Before You Start
6+
7+
- Read the [README](README.md) for an overview of the project
8+
- This project runs performance and load testing tools on Azure Local clusters — **test all changes in a non-production environment**
9+
- Check open issues and pull requests to avoid duplicate work
10+
11+
## How to Contribute
12+
13+
### Reporting Bugs
14+
15+
Use the [bug report issue template](.github/ISSUE_TEMPLATE/bug_report.md). Include:
16+
- Azure Local version (22H2, 23H2, etc.)
17+
- Cluster and storage configuration
18+
- Which tool or script failed (VMFleet, fio, iPerf, HammerDB, stress-ng)
19+
- Full error message and relevant log output
20+
21+
### Suggesting Features
22+
23+
Use the [feature request issue template](.github/ISSUE_TEMPLATE/feature_request.md). Describe the use case, not just the solution.
24+
25+
### Documentation Issues
26+
27+
Use the [documentation issue template](.github/ISSUE_TEMPLATE/docs_issue.md) for missing, incorrect, or unclear docs.
28+
29+
### Submitting Pull Requests
30+
31+
1. Fork the repo and create a branch from `main`
32+
2. Name branches using conventional types: `feat/vmfleet-monitoring`, `fix/iperf-timeout`, `docs/workload-profiles`
33+
3. Keep changes focused — one logical change per PR
34+
4. Update the README and relevant `docs/` pages if your change affects usage or prerequisites
35+
5. Add an entry to [CHANGELOG.md](CHANGELOG.md) under `[Unreleased]`
36+
6. Test your changes against at least one real Azure Local environment before submitting
37+
7. Fill out the pull request template completely
38+
39+
## Commit Messages
40+
41+
This project uses [Conventional Commits](https://www.conventionalcommits.org/):
42+
43+
```
44+
<type>(<scope>): <description>
45+
```
46+
47+
| Type | When |
48+
|------|------|
49+
| `feat` | New feature |
50+
| `fix` | Bug fix |
51+
| `docs` | Documentation only |
52+
| `infra` | CI/CD, workflows, config |
53+
| `chore` | Maintenance |
54+
| `refactor` | Code improvement, no behavior change |
55+
| `test` | Tests |
56+
57+
Examples:
58+
- `feat(vmfleet): add IOPS trending dashboard`
59+
- `fix(fio): correct block size parameter parsing`
60+
- `docs(getting-started): add cluster prerequisites`
61+
62+
## Development Guidelines
63+
64+
### PowerShell Style
65+
66+
- Use approved PowerShell verbs (`Get-`, `Set-`, `New-`, `Remove-`, etc.)
67+
- Include `[CmdletBinding()]` and `param()` blocks on all scripts
68+
- Use `Write-Verbose` for diagnostic output, `Write-Warning` for non-fatal issues, `Write-Error` for failures
69+
- Guard destructive operations with `-WhatIf` / `-Confirm` where practical
70+
71+
### Testing
72+
73+
- Test against a real Azure Local environment before submitting
74+
- Include performance baselines or comparative results when relevant
75+
- Describe your test environment and results in the PR
76+
77+
## Code of Conduct
78+
79+
Be respectful and constructive. Keep discussions on-topic and collaborative.

0 commit comments

Comments
 (0)