|
| 1 | +# Maintainer Guide |
| 2 | + |
| 3 | +This guide is for maintaining the public GitHub repository. |
| 4 | + |
| 5 | +## Suggested Labels |
| 6 | + |
| 7 | +Create these labels in GitHub: |
| 8 | + |
| 9 | +| Label | Purpose | |
| 10 | +| --- | --- | |
| 11 | +| `bug` | Something is broken. | |
| 12 | +| `enhancement` | New feature or improvement. | |
| 13 | +| `docs` | Documentation work. | |
| 14 | +| `scenario` | Benchmark scenario or workload work. | |
| 15 | +| `observability` | Grafana, InfluxDB, metrics, dashboards. | |
| 16 | +| `runner` | CLI, config parsing, NBomber execution. | |
| 17 | +| `docker` | Docker/Compose target or stack changes. | |
| 18 | +| `good first issue` | Small scoped issue for new contributors. | |
| 19 | +| `help wanted` | Maintainer wants outside input. | |
| 20 | +| `question` | Needs clarification or discussion. | |
| 21 | + |
| 22 | +## Suggested Milestones |
| 23 | + |
| 24 | +Initial milestones: |
| 25 | + |
| 26 | +- `MVP` |
| 27 | +- `Serious Benchmarking` |
| 28 | +- `Observability` |
| 29 | +- `Scenario Packs` |
| 30 | +- `Docs` |
| 31 | + |
| 32 | +## Issue Style |
| 33 | + |
| 34 | +Good issues should include: |
| 35 | + |
| 36 | +- what is needed; |
| 37 | +- why it matters; |
| 38 | +- expected behavior; |
| 39 | +- rough implementation notes if known; |
| 40 | +- verification criteria. |
| 41 | + |
| 42 | +Example: |
| 43 | + |
| 44 | +```md |
| 45 | +## Goal |
| 46 | + |
| 47 | +Add ramping load profile support to benchmark config. |
| 48 | + |
| 49 | +## Why |
| 50 | + |
| 51 | +Baseline runs need constant load, but stress tests need increasing load. |
| 52 | + |
| 53 | +## Acceptance Criteria |
| 54 | + |
| 55 | +- Config supports constant and ramping profiles. |
| 56 | +- README includes an example. |
| 57 | +- Existing http-smoke config still works. |
| 58 | +- `dotnet build ScenarioBench.sln --no-restore -m:1 -v:minimal` passes. |
| 59 | +``` |
| 60 | + |
| 61 | +## Pull Request Review |
| 62 | + |
| 63 | +Review priority: |
| 64 | + |
| 65 | +1. Correctness and reproducibility. |
| 66 | +2. Public repo safety. |
| 67 | +3. Clear config/report behavior. |
| 68 | +4. Docs and examples. |
| 69 | +5. Code style. |
| 70 | + |
0 commit comments