|
| 1 | +.. _doc_updating_the_contributing_docs: |
| 2 | + |
| 3 | +Contributing to the contributing docs |
| 4 | +===================================== |
| 5 | + |
| 6 | +The contributing documentation documents how people can best contribute |
| 7 | +to Godot. It is the website you are looking at right now! |
| 8 | + |
| 9 | +As an important part of Godot, we'd like to see this documentation evolve |
| 10 | +and improve alongside the rest of Godot. Community involvement is just as |
| 11 | +welcome on this site as in the rest of Godot's documentation! |
| 12 | + |
| 13 | +If you'd like to submit an idea for a change of guidelines or operations, |
| 14 | +please consider proposing it as an `idea <_doc_contributing_ideas>`__ |
| 15 | +instead of attempting to change the docs directly. |
| 16 | + |
| 17 | +Making changes to the contributing docs |
| 18 | +======================================= |
| 19 | + |
| 20 | +The information on this site are managed in a GitHub repository |
| 21 | +(`github.com/godotengine/godot-contributing-docs <https://github.com/godotengine/godot-contributing-docs>`__). |
| 22 | +You can contribute to this repository using our regular |
| 23 | +`PR workflow <_doc_pr_workflow>`__. Please adhere to our |
| 24 | +`documentation guidelines <_doc_documentation_guidelines>`__ when making |
| 25 | +changes. |
| 26 | + |
| 27 | +To get started quickly, visit any article on this site and click the "Edit |
| 28 | +on GitHub" button in the top right of the page. |
| 29 | + |
| 30 | +What kinds of information are documented here? |
| 31 | +============================================== |
| 32 | + |
| 33 | +This page is intended for people who are interested in contributing to |
| 34 | +Godot. They should be able to quickly find out how they can contribute, |
| 35 | +be guided to confidently make their first contributions, and be able to |
| 36 | +find all the relevant guidelines to become proficient contributors. |
| 37 | + |
| 38 | +It can be difficult to determine if any piece of information should be |
| 39 | +documented here or elsewhere. Consider reading the following examples |
| 40 | +to get an idea. |
| 41 | + |
| 42 | +The following kinds of information **should** be documented here: |
| 43 | + |
| 44 | +* The expected workflow for contributing to any area of Godot (engine, documentation, etc.). |
| 45 | +* The guidelines for contributing to any project. |
| 46 | +* Organizational structures (tools and teams) of Godot contributors. |
| 47 | + |
| 48 | +The following kinds of information **should not** be documented here: |
| 49 | + |
| 50 | +* Information that is relevant to regular users of Godot (not just potential contributors). |
| 51 | + * Please document this in `docs.godotengine.org <https://docs.godotengine.org>`__ |
| 52 | +* Information that changes across different versions of Godot. |
| 53 | + * Please document this in `docs.godotengine.org <https://docs.godotengine.org>`__ |
| 54 | +* Technical information about any of Godot's repositories. |
| 55 | + * Please document this in the respective repositories. |
| 56 | + |
| 57 | +How is this page structured? |
| 58 | +============================ |
| 59 | + |
| 60 | +This page is structured such that it is easy to find the different ways |
| 61 | +in which you can contribute to Godot. To accomplish this, every *kind* |
| 62 | +of contribution should have a dedicated section in the side bar. If a new |
| 63 | +way to contribute emerges, it should get a dedicated section in the side |
| 64 | +bar so that it is easy to find. |
0 commit comments