Skip to content

Commit 86192a2

Browse files
authored
Merge pull request #9609 from MurderVeggie/how-to-contribute
Fresh "How to contribute" page
2 parents 10e686a + ffdc9b1 commit 86192a2

File tree

5 files changed

+114
-52
lines changed

5 files changed

+114
-52
lines changed

_tools/redirects/redirects.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ source,destination
1414
/community/contributing/docs_writing_guidelines.html,/contributing/documentation/docs_writing_guidelines.html
1515
/community/contributing/editor_and_docs_localization.html,/contributing/documentation/editor_and_docs_localization.html
1616
/community/contributing/index.html,/contributing/ways_to_contribute.html
17+
/community/contributing/ways_to_contribute.html,/contributing/how_to_contribute.html
1718
/community/contributing/pr_workflow.html,/contributing/workflow/pr_workflow.html
1819
/community/contributing/testing_pull_requests.html,/contributing/workflow/testing_pull_requests.html
1920
/community/contributing/updating_the_class_reference.html,/contributing/documentation/updating_the_class_reference.html

contributing/how_to_contribute.rst

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
.. _doc_ways_to_contribute:
2+
3+
How to contribute
4+
=================
5+
6+
The Godot Engine is free and open-source. Like any community-driven project, we rely on volunteer contributions.
7+
On this page we want to showcase the various ways you as users can participate - to help you find the right starting place with the skillset you have.
8+
Because contrary to popular opinion, we need more than just programmers on the project!
9+
10+
11+
Fundraising
12+
-----------
13+
14+
- **Donate**
15+
16+
We created the non-profit `Godot Foundation <https://godot.foundation/>`_ to be able to support the Godot Engine in both matters of finance and administration.
17+
In practice, this means the Foundation hires people to work part-time or full-time on the project.
18+
These jobs include engine development as well as related tasks like code reviews, production management, community & marketing efforts, and more.
19+
20+
With as little as 5 EUR per month, you can help us keep going strong.
21+
Currently, we are intending to hire more core developers, as to cover more ground with full-time specialists that supplement and guide volunteer work.
22+
23+
`Join the Development Fund <fund.godotengine.org>`_
24+
25+
- **Donation Drives**
26+
Think about your followers on social media, or other communities you are active in.
27+
Use that reach to remind your social environment that even small contributions can make a difference, especially when done by a great number of people at the same time.
28+
29+
Are you a content creator? Consider adding a link to the `Godot Development Fund <fund.godotengine.org>`_ to your descriptions.
30+
If you do live streams, perhaps think about organizing a stream with donation incentives.
31+
32+
.. - **Buy Official Merch**
33+
34+
- **Publish Godot Games.**
35+
You heard right, simply publishing a game #MadeWithGodot can positively impact the well-being of this project.
36+
Your personal success elevates the engine to a viable alternative for other developers, growing the community further.
37+
Additionally, it opens the doors for us to approach industry contacts about possible cooperations.
38+
39+
40+
Technical contributions
41+
-----------------------
42+
43+
- **Report bugs & other issues**
44+
As active users of the engine, you are better equipped to identify bugs and other issues than anyone else.
45+
To let us know about your findings, fill out this `bug report form <https://github.com/godotengine/godot/issues/new/choose>`_ on our GitHub.
46+
Make sure to include as much information as possible to ensure these issues can easily be reproduced by others.
47+
48+
If you are interested in helping keep our bug tracker organized, you can even join the `bugsquad <https://chat.godotengine.org/channel/bugsquad>`_!
49+
50+
- **Test Development Versions**
51+
While it is recommended to use the stable releases for your projects, you can help us test dev releases, betas, and release candidates
52+
by opening a copy of your project in them and checking what problems this introduces or maybe even solves.
53+
Make sure to have a backup ready, since this can produce irreversible changes.
54+
55+
Find recent `development versions <https://godotengine.org/download/preview/>`_ directly on our download page, or linked in their own blog posts.
56+
57+
- **Contribute Engine Code (mainly C++)**
58+
The engine development is mainly coordinated on our `Contributor RocketChat <https://chat.godotengine.org/>`_,
59+
so if you are serious about making PRs you should join us there!
60+
61+
Read more about the **technical submission process**: :ref:`doc_first_steps`
62+
63+
For each subject area of the engine, there is a corresponding team to coordinate the work.
64+
Join the linked chat to get more eyes on your related PR, learn about open todos, or partake in meetings.
65+
For some areas, specialists might even be encouraged to step up as maintainer!
66+
`List of teams <https://godotengine.org/teams/>`_
67+
68+
- **Review Code Contributions**
69+
All pull requests need to be thoroughly reviewed before they can be merged into the master branch.
70+
Help us get a headstart by participating in the code review process.
71+
72+
To get started, chose any `open pull request <https://github.com/godotengine/godot/pulls>`_ and reference our **style guide**: :ref:`doc_pr_review_guidelines`
73+
74+
- **Write Plugins (GDScript, C#, & more)**
75+
Community addons are not directly included in the core engine download or repository, yet they provide essential quality of life upgrades for your fellow game developers.
76+
Upload your plugins to the `Godot Asset Library <https://godotengine.org/asset-library/asset>`_ to make them available to others.
77+
.. update to talk about Asset Store later
78+
79+
- **Demo projects (GDScript, C#, and making Assets)**
80+
We provide new users with `demo projects <https://github.com/godotengine/godot-demo-projects/>`_ so they can quickly test new features or get familiar with the engine in the first place.
81+
At industry events, we might even exhibit these demo projects to showcase what Godot can do!
82+
Help improve existing projects or supply your own to be added to the pool, and join the `demo channel <https://chat.godotengine.org/channel/demo-content>`_ in the Contributor RocketChat to talk about it.
83+
84+
- **Documentation**
85+
The documentation is one of the most essential parts of any tech project, yet the need to document new features and substantial changes often gets overlooked.
86+
Join the `documentation team <https://chat.godotengine.org/channel/documentation>`_ to improve the Godot Engine with your technical writing skills.
87+
88+
- **Translations (spoken languages other than English)**
89+
Are you interested in making the Godot Engine more accessible to non-English speakers?
90+
Contribute to our `community-translations <https://hosted.weblate.org/projects/godot-engine/godot/>`_.
91+
92+
Community support
93+
-----------------
94+
95+
- **Call for Moderators**
96+
With a community of our size, we need people to step up as volunteer moderators in all kinds of places.
97+
These teams are organized by the Godot Foundation, but would not function without the dedication of active community members like you.
98+
99+
Have a look around your favorite community platform and you might come across open application calls.
100+
101+
- **Answer tech-support questions**
102+
With many new people discovering the Godot Engine recently, the need for peer-to-peer tech-support has never been greater.
103+
Be it on the `Forum <https://forum.godotengine.org/>`_, our `subreddit <https://www.reddit.com/r/godot/>`_, or on `Discord <https://discord.gg/bdcfAYM4W9>`_, you can always brighten someone's day by helping them get their personal projects back on track.
104+
105+
- **Create tutorials & more**
106+
How did you get started with the Godot Engine?
107+
Chances are you looked for learning materials outside of what the documentation provides.
108+
Without content creators covering the game development process, there would not be this big of a community today.
109+
Therefore it seemed only right to mention them in a page about important contributions to the project.
110+

contributing/ways_to_contribute.rst renamed to contributing/workflow/first_steps.rst

Lines changed: 1 addition & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,4 @@
1-
.. _doc_ways_to_contribute:
2-
3-
Ways to contribute
4-
==================
5-
6-
Godot Engine is a non-profit, community-driven free and open source project.
7-
Almost all (but our lead dev Juan, more on that below) developers are working
8-
*pro bono* on their free time, out of personal interest and for the love of
9-
creating a libre engine of exceptional quality.
10-
11-
This means that to thrive, Godot needs as many users as possible to get
12-
involved by contributing to the engine. There are many ways to contribute to
13-
such a big project, making it possible for everybody to bring something
14-
positive to the engine, regardless of their skill set:
15-
16-
- **Be part of the community.** The best way to contribute to Godot and help
17-
it become ever better is simply to use the engine and promote it by
18-
word-of-mouth, in the credits or splash screen of your games, blog posts, tutorials,
19-
videos, demos, gamedev or free software events, support on the Q&A, forums,
20-
Contributors Chat, Discord, etc. Participate!
21-
Being a user and advocate helps spread the word about our great engine,
22-
which has no marketing budget and can therefore only rely on its community
23-
to become more mainstream.
24-
25-
- **Make games.** It's no secret that, to convince new users and especially the
26-
industry at large that Godot is a relevant market player, we need great games
27-
made with Godot. We know that the engine has a lot of potential, both for 2D
28-
and 3D games, but given its young age we still lack big releases that will
29-
draw attention to Godot. So keep working on your awesome projects, each new
30-
game increases our credibility on the gamedev market!
31-
32-
- **Get involved in the engine's development.** This can be by contributing
33-
code via pull requests, testing the development snapshots or directly the
34-
git *master* branch, report bugs or suggest enhancements on the issue
35-
tracker, improve the official documentation (both the class reference and
36-
tutorials) and its translations.
37-
The following sections will cover each of those "direct" ways
38-
of contributing to the engine.
39-
40-
- **Donate.** Godot is a non-profit project, but it can still benefit from
41-
user donations for many things. Apart from usual expenses such as hosting
42-
costs or promotional material on events, we also use donation money to
43-
acquire hardware when necessary (e.g. we used donation money to buy a
44-
MacBook Pro to implement Retina/HiDPI support and various other
45-
macOS-related features).
46-
Most importantly, we also used donation money to hire core developers so they
47-
can work full-time on the engine. Even with a low
48-
monthly wage, we need a steady donation income to continue doing this, which
49-
has been very beneficial to the project so far. So if you want to donate
50-
some money to the project, check `our website <https://godotengine.org/donate>`_
51-
for details.
1+
.. _doc_first_steps:
522

533
Contributing code
544
-----------------

contributing/workflow/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ approach the project.
1414
:maxdepth: 1
1515
:name: toc-contributing-workflow
1616

17+
first_steps
1718
bisecting_regressions
1819
bug_triage_guidelines
1920
pr_workflow

index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ the ``GodotEngine.epub`` file in an e-book reader application.
131131
:caption: Contributing
132132
:name: sec-contributing
133133

134-
contributing/ways_to_contribute
134+
contributing/how_to_contribute
135135
contributing/workflow/index
136136
contributing/development/index
137137
contributing/documentation/index

0 commit comments

Comments
 (0)