Skip to content

Commit 03dedd2

Browse files
committed
docs: update contribution guidelines for AI agents
Signed-off-by: David Calvert <[email protected]>
1 parent a5ce3d4 commit 03dedd2

1 file changed

Lines changed: 20 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Please note that this project is released with a [Contributor Code of Conduct](C
55
## Project Scope
66

77
This project aims to offer a set of modern Grafana dashboards for Kubernetes.\
8-
Because setups could be very diverse, it is not possible to make theses dashboards universal.\
8+
Because setups could be very diverse, it is not possible to make these dashboards universal.\
99
Changes are welcome as soon as they work with [kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack).
1010

1111
## How to Contribute
@@ -18,3 +18,22 @@ Changes are welcome as soon as they work with [kube-prometheus-stack](https://gi
1818
- Bump dashboard(s) version(s)
1919
- [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) is preferred
2020
- [Signed commits](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff) is preferred
21+
22+
## AI-assisted contributions
23+
24+
Contributions generated or significantly assisted by AI tools (LLMs, coding agents, etc.) are welcome, but must be clearly identified to help maintainers review them appropriately.
25+
26+
- **Commits:** use the `🤖` scope in your conventional commit message, e.g.:
27+
28+
```text
29+
feat(🤖): add memory usage panel to k8s-views-pods
30+
fix(🤖): correct CPU throttling query
31+
```
32+
33+
- **Pull requests:** prefix the PR title with `[🤖]`, e.g.:
34+
35+
```text
36+
[🤖] feat: add network I/O breakdown panel
37+
```
38+
39+
AI-generated content is held to the same quality standards as any other contribution. Maintainers may ask for clarification or request changes, just as with any PR.

0 commit comments

Comments
 (0)