coreos/prometheus-operator
1
0
Fork 0
mirror of https://github.com/coreos/prometheus-operator.git synced 2026-02-05 06:45:27 +01:00
Code Issues Releases Wiki Activity

docs: cover AI contributions in CONTRIBUTING.md

Browse Source 
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
This commit is contained in:
Simon Pasquier
2025-12-08 17:09:27 +01:00
parent dea90f2f72
commit 288ed3f491
2 changed files with 28 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@@ -2,9 +2,11 @@
_Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request._
_If it fixes an existing issue (bug or feature), use the following keyword:_
<!-- If it fixes an existing issue (bug or feature), use the following keyword -->
_Closes: #ISSUE-NUMBER_
Closes: #ISSUE-NUMBER
If you're contributing for the first-time, check our [contribution guidelines](../CONTRIBUTING.md).
## Type of change

24
CONTRIBUTING.md
View File

@@ -115,6 +115,30 @@ second line is always blank, and other lines should be wrapped at 80 characters.
This allows the message to be easier to read on GitHub as well as in various
Git tools.
## AI use policy
We allow the use of AI tools when contributing to the project (issues and pull
requests). At the same time, you need to be mindful of maintainers' time and
attention which is why we ask you to comply with the following guidelines.
### When using AI for learning
* Keep in mind that while AI assistants help with navigating and understanding the code base, you need to take their claims with a grain of salt.
* Using AI tools doesn't prevent you from becoming familiar with the code and the development workflow.
### 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.
### When using AI for code contribution
* Review the change by yourself before submitting the pull request.
* Ensure that you can explain the why, what and how of the change without help from the AI tool.
* 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.
## Local Development
If you want to run Prometheus Operator on your local environment, you can follow the steps below.