generated from readthedocs/tutorial-template
-
-
Notifications
You must be signed in to change notification settings - Fork 11
Add a page for general contribution guidelines, with a code of conduct and AI disclaimer #19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Ivorforce
wants to merge
1
commit into
godotengine:main
Choose a base branch
from
Ivorforce:general-guidelines
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| General rules and guidelines | ||
| ============================ | ||
|
|
||
| This page contains guidelines relevant for contributing to any area of Godot. | ||
|
|
||
| When contributing to any particular area, please also refer to its respective guidelines. | ||
|
|
||
| Code of conduct | ||
| --------------- | ||
|
|
||
| When you contribute to Godot, we expect that you respect our `Code of Conduct <https://godotengine.org/code-of-conduct/>`__. | ||
|
|
||
| Contributing with AI and large language models | ||
| ---------------------------------------------- | ||
|
|
||
| .. note:: When this page refers to "AI" it means any LLM/generative | ||
| AI model like ChatGPT, Claude, Grok, etc., or any other | ||
| models that fulfill the same role. | ||
|
|
||
| The use of AI to contribute to Godot is discouraged. | ||
| We acknowledge that AI can be useful, but we are convinced that human effort results in better and more relevant | ||
| contributions. | ||
|
|
||
| If you use AI to assist with your contribution, you are required to: | ||
|
|
||
| - Understand and verify any of its solutions. | ||
| - If you don't understand the solution, do not submit it. | ||
| - Proofread and edit anything it generates. | ||
| - Alternatively, it would be better to let AI proofread something you created *on your own*. | ||
| - Disclose how and how much you used AI for your contribution. | ||
| - In particular, you must disclose if you used AI to write part of your contribution or issue/pull request description. | ||
| - Using translation software for text that you originally wrote is acceptable for issues and pull requests. | ||
|
|
||
| As a rule of thumb, only submit code that you fully understand and are prepared to explain to a maintainer. Maintainers | ||
| are spending their personal time reviewing your code, it is your job to ensure that the code you submit is well-tested | ||
| and functional. Please be respectful of their time and only submit code that you have put thought and effort into. | ||
| Contributions made entirely by AI are prohibited. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I want to follow up the strict rules with a more general re-statement that clarifies why we don't want people to just dump fully AI authored code.
I am tempted to add something like "I don't want to bother reviewing code that you didn't bother writing" But I think that is a little to snarky for this sort of text.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is a good way to say that but professionally and politely
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Prohibited" itself is an excessively strong word. We don't often ban users for their low-quality submissions, nor we have the authority to prevent them from submitting them in the first place (which is what "prohibit" implies in my opinion).
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally I would agree, but in this case I think it may be appropriate. We don't want users setting up AI agents with the task of "Look through the Godot source code and submit fixes for bugs as PRs".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with Ivor here. Generally "prohibit" is much too strong of a word. But in this case we need to be extremely firm or else we might as well say nothing at all.
Language like "we encourage you not to submit PRs made entirely by AI" is practically useless.
Importantly, we aren't saying you can't submit a PR with some AI generated code. What is prohibited are PRs that are made entirely by AI without being validated
Perhaps an acceptable compromise would be:
"Contributions made entirely by AI without careful human testing and validation are prohibited."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If the human is testing and validating, that wouldn't be entirely AI authored anymore, right? If the improvement is simple, that's already more work than what the AI "put in", and if it's complex, it's doomed to fail anyway 😅