User-contributed notes policy – Read before posting · godotengine/godot-docs-user-notes · Discussion #1 (original) (raw)

By submitting a note, you agree to uphold the Godot Engine Code of Conduct.

Welcome to the user-contributed notes of the Godot documentation! Here, you can find rules about the types of comments that are allowed.

✅ What user-contributed notes are for

• Share additional information relevant to the article.
• Mention a workaround for a common issue.
• Link to useful third-party resources that are relevant to the current page, such as tutorials or add-ons.
  • It is allowed to occasionally link to resources you've created. When doing so, you must disclose your affiliation with the resource in some way. However, linking to resources you've created should not represent the majority of your interactions with user notes. Excessive self-promotion is not allowed and will be moderated away.

🚫 What user-contributed notes are not for

• Do not point out something in the documentation being incorrect or outdated.
  • Instead, open an issue on the godot-docs issue tracker. If you can, please open a pull request to improve the documentation.
  • You can use the Edit on GitHub button at the top-right corner of each documentation page for this purpose.
• Do not ask support questions. Please use other community platforms instead.
• Do not submit bug reports. Please use the main Godot repository's issue tracker instead.
• Do not submit feature requests. Please use the Godot proposals repository instead.
• Do not post off-topic comments. Comments must be strictly related to the page they are linked to.

Comments not following the above rules will be removed.

Licensing of user-contributed notes

Please note that engine contributors occasionally go through the notes and may incorporate information from them in the documentation. By submitting a note, you accept that it may be incorporated in unmodified or modified form in the engine and/or documentation, subject to the MIT license for the engine and CC BY 3.0 license for the documentation.