Skip to content

Commit a7bb82b

Browse files
HybridOps Export Botjeleel-muibi
authored andcommitted
docs: add workloads contribution guide
1 parent cee5678 commit a7bb82b

1 file changed

Lines changed: 51 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing to HybridOps Workloads
2+
3+
This repository holds the public workload baseline for HybridOps.
4+
Contributions are welcome when they improve a reusable workload, public target,
5+
or the validation behind them.
6+
7+
## Before you start
8+
9+
Read [STANDARD.md](STANDARD.md) first. It defines the boundary between public,
10+
customer-consumable workloads and internal delivery material.
11+
12+
Open an issue before starting a new application family, cluster target, or a
13+
change to an existing application's default behaviour. Direct pull requests are
14+
welcome for contained documentation fixes, manifest corrections, and validation
15+
improvements.
16+
17+
## Scope
18+
19+
- Keep application definitions and overlays reusable across customer
20+
environments.
21+
- Keep `clusters/` limited to public target groupings.
22+
- Do not add credentials, private addresses, customer-specific domains, or
23+
internal rollout material.
24+
- Update the relevant operator documentation when a user-visible workload
25+
behaviour changes.
26+
27+
## Validate the change
28+
29+
Run the validator for every target affected by the change:
30+
31+
```bash
32+
./scripts/validate.sh --strict --target onprem-smoke
33+
./scripts/validate.sh --strict --target onprem-stage1
34+
./scripts/validate.sh --strict --target burst
35+
./scripts/validate.sh --target onprem
36+
```
37+
38+
For a narrowly scoped change, run at least the affected target. Run the full
39+
set when changing shared applications, validation logic, or cluster wiring.
40+
41+
## Pull requests
42+
43+
Keep each pull request focused. Include the target affected, a short summary of
44+
the change, and the validation commands you ran. Call out any checks you could
45+
not run locally.
46+
47+
## Security
48+
49+
Do not include secrets or vulnerability details in a public issue or pull
50+
request. For a suspected security issue, use the
51+
[HybridOps contact form](https://hybridops.tech/contact?intent=general&source=workloads-contributing&target=Security%20report&return=https%3A%2F%2Fdocs.hybridops.tech%2Fguides%2Freference%2Fcontributing%2F).

0 commit comments

Comments
 (0)