From 6d0e8f87166c3c4aa0be877bfdd31f58574364bc Mon Sep 17 00:00:00 2001 From: Jayapriya Pai Date: Fri, 30 Jan 2026 15:53:09 +0530 Subject: [PATCH] docs: update AI usage policy Signed-off-by: Jayapriya Pai --- CONTRIBUTING.md | 3 ++- README.md | 4 ++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2501a9db6..e4037b40c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -129,7 +129,7 @@ attention which is why we ask you to comply with the following guidelines. ### When using AI for communication * Follow the proposed template when submitting GitHub issues. -* Avoid verbose descriptions, provide enough information for the maintainers to understand the request but do not overwhelm them with unrelated details. +* **Avoid verbose descriptions**, provide enough information for the maintainers to understand the request but do not overwhelm them with unrelated details. ### When using AI for code contribution @@ -138,6 +138,7 @@ attention which is why we ask you to comply with the following guidelines. * If necessary call out the parts which are unclear to you. * When AI tools have contributed significant parts of the code change, communicate the information in the pull request's description and/or the commit message. * Don't submit changes which are unrelated to the purpose of the pull request. +* **Avoid verbose AI-generated descriptions in PRs** keep descriptions concise, focused, and relevant to the actual changes being made. ## Local Development diff --git a/README.md b/README.md index 598608073..e929de1a2 100644 --- a/README.md +++ b/README.md @@ -173,6 +173,10 @@ See [TESTING](TESTING.md) See [CONTRIBUTING](CONTRIBUTING.md). +## AI Usage Policy + +See [AI Usage Policy](CONTRIBUTING.md#ai-use-policy) in our Contributing guidelines for information on using AI tools when contributing to the project. + ## Security If you find a security vulnerability related to the Prometheus Operator which