diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0d3caacf1..0cf51842f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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:_ + -_Closes: #ISSUE-NUMBER_ +Closes: #ISSUE-NUMBER + +If you're contributing for the first-time, check our [contribution guidelines](../CONTRIBUTING.md). ## Type of change diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ad7256f5b..2501a9db6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.