generated from readthedocs/tutorial-template
-
-
Notifications
You must be signed in to change notification settings - Fork 11
Add a page for general contribution guidelines. #28
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-v2
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
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
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,69 @@ | ||
| 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. | ||
|
|
||
| Respect our Code of Conduct | ||
| ------------------------------- | ||
|
|
||
| When you contribute to Godot, we expect that you respect our `Code of Conduct <https://godotengine.org/code-of-conduct/>`__. | ||
|
|
||
| .. _doc_licenses: | ||
|
|
||
| Respect copyright | ||
| ----------------- | ||
|
|
||
| You must be mindful of the copyright and patent rights of anything you submit. | ||
|
|
||
| If you authored every part of your contribution and own the rights, this is not a problem. | ||
| You can submit your contribution without reading further. | ||
|
|
||
| However, any code or assets you took from somewhere else may be subject to copyright or patent rights, | ||
| which you must respect. In such cases, you need to check the license of the material. Some licenses are permissive | ||
| enough to be compatible with Godot's `MIT license <https://github.com/godotengine/godot/blob/master/LICENSE.txt>`. | ||
| You must include this license in your contribution. | ||
| Examples of compatible licenses include Apache 2.0, BSD, ISC, MPL 2.0, and MIT itself. | ||
|
|
||
| However, others are not compatible with Godot's license. This includes "copy-left" licenses like GPL or LGPL, | ||
| since these licenses effectively disallow static linking in proprietary software | ||
| (which Godot is distributed as in most exported projects). | ||
| This also applies for libraries that are only linked in the editor. | ||
|
|
||
| "Source-available" is **not** "open-source". For example, you cannot submit exclusive code or ideas from proprietary | ||
| game engines like Unreal or Unity, nor use their code as inspiration. We strongly recommend against reading any | ||
| "source-available" code before contributing to Godot. | ||
|
|
||
| Contribute only what you understand | ||
| ----------------------------------- | ||
|
|
||
| Please only submit code that you understand and are prepared to explain to a maintainer. | ||
|
|
||
| If you do not fully understand the code, please take extra care to test it rigorously, and disclose this in your | ||
| pull request description. | ||
|
|
||
| This especially applies if you implement the idea of another person, copy code from elsewhere, or if you use AI to | ||
| assist you with your contribution. In all of these cases, you must disclose which part of your submission wasn't fully | ||
| authored by you. | ||
|
|
||
| AI-assisted contributions | ||
| ------------------------- | ||
|
|
||
| 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. | ||
|
|
||
| .. note:: "AI" in this page refers to any LLM/generative | ||
| AI model like ChatGPT, Claude, Grok, etc., or any other | ||
| models that fulfill the same role. Using translation | ||
| software to communicate is fine, and single-line code | ||
| completion does not have to be disclosed. | ||
|
|
||
| If you do use AI, we expect that you put in effort to proofread and improve anything it generates, and that you disclose | ||
| what you used AI for. Maintainers are spending their personal time reviewing your code, please make sure | ||
| that the code you submit is well-tested and functional. | ||
| Please be respectful of their time and only submit something 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.
Uh oh!
There was an error while loading. Please reload this page.