mirror of https://github.com/sbt/sbt.git
Update contributing to clarify AI usages (#8657)
This commit is contained in:
parent
627c484cd8
commit
f05a96aceb
|
|
@ -30,7 +30,7 @@ Patching the core (send pull requests)
|
|||
This section describes how you can create Pull Requests (PRs) and describes coding standards we use when implementing them.
|
||||
|
||||
<a id="important"></a>
|
||||
### **Important**: ⚠️ Please test before sending a PR
|
||||
### **Important**: ⚠️ Pull request must be tested with GitHub Actions or human-in-the-loop
|
||||
|
||||
Given the wide user base and the long history, not all issues are valid or relevant.
|
||||
|
||||
|
|
@ -46,17 +46,19 @@ must minimize the review burden. Maintainers might close a PR if it fails to pas
|
|||
If you can express the reproduction as a test that would be great, but often the problems require locally building sbt and running test builds yourself. For local testing, post screenshots or screencast to demonstrate that the fix works at least on your machine.
|
||||
|
||||
<a id="genai"></a>
|
||||
### Gen-AI assisted contributions
|
||||
### AI assisted contributions
|
||||
|
||||
Generally, it's fine to use Gen-AI tools to help you create Pull Requests for sbt as long as you adhere to the following guidelines:
|
||||
Generally, it's fine to use AI tools to help you create Pull Requests for sbt as long as you adhere to the following guidelines:
|
||||
|
||||
- State in your PR description that you have used Gen-AI tools to assist in creating the PR.
|
||||
- Pull requests created by AI must have been fully verified with **human-in-the-loop**. Actually run sbt to test your changes.
|
||||
- **All AI usage in any form must be disclosed**. State in your PR description that you have used AI tools to assist in creating the PR.
|
||||
- No third party materials are included in the output; or materials that are included in the output are in compliance with an open source license compatible with Apache License.
|
||||
- Ensure that you review and understand all code generated by Gen-AI tools before including it in your PR - do not blindly trust the generated code.
|
||||
- Remember that the final responsibility for the code in your PR lies with you, regardless of whether it was generated by a tool or written by you.
|
||||
- Blindly copy-pasting code from Gen-AI tools is detrimental as it might introduce security and stability risks to the project.
|
||||
- Ensure that you review and understand all code generated by AI tools before including it in your PR - do not blindly trust the generated code. The final responsibility for the code in your PR lies with you.
|
||||
- Blindly copy-pasting code from AI tools is detrimental as it might introduce security and stability risks to the project.
|
||||
|
||||
⚠️ Maintainers that spot untested, unexplainable, Gen-AI copy-pasted PRs will close the related PRs and block the user from making further contributions. ⚠️
|
||||
⚠️ Maintainers that spot untested, unexplainable, AI copy-pasted PRs will close the related PRs and block the user from making further contributions. ⚠️
|
||||
|
||||
In a perfect world, AI would produce high-quality, accurate work every time. But today, that reality depends on the driver of the AI. And today, most drivers of AI are just not good enough. So, until either the people get better, the AI gets better, or both, we have to have strict rules to protect Maintainers.
|
||||
|
||||
<a id="getting-started"></a>
|
||||
### Getting started
|
||||
|
|
|
|||
Loading…
Reference in New Issue