Skip to content
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

Fresh "How to contribute" page #9609

Merged
merged 23 commits into from
Jul 19, 2024

Conversation

MurderVeggie
Copy link
Contributor

The original page was so old, it still listed Juan as the lone core developer. Rewritten from scratch to reflect the different avenues of support, including funding and non-tech contributions.

This page is directly linked to the "Contribute" button on the main website, by the way.

This page was so old, it still listed Juan as the lone core developer. Rewritten from scratch to reflect the different avenues of support, including funding and non-tech contributions.
@AThousandShips AThousandShips added enhancement cherrypick:3.5 cherrypick:3.6 area:contributing Issues and PRs related to the Contributing/Development section of the documentation cherrypick:4.1 cherrypick:4.2 labels Jul 15, 2024
Copy link
Member

@AThousandShips AThousandShips left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will take a second look at the wording too when I have a little more energy

contributing/how_to_contribute.rst Outdated Show resolved Hide resolved
contributing/how_to_contribute.rst Outdated Show resolved Hide resolved
contributing/how_to_contribute.rst Outdated Show resolved Hide resolved
contributing/how_to_contribute.rst Outdated Show resolved Hide resolved
@mhilbrunner
Copy link
Member

mhilbrunner commented Jul 15, 2024

Looks good after a first read. The link to this file in godot-docs/index.rst:130 needs to be adapted as well. Will give it a more in-depth read later. :)

MurderVeggie and others added 4 commits July 15, 2024 21:21
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Copy link
Contributor

@skyace65 skyace65 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Haven't read through everything yet, just checked the build issue

contributing/how_to_contribute.rst Outdated Show resolved Hide resolved
Copy link
Member

@Piralein Piralein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work!

Its possible the external links will throw errors on build, because some have the same name as others, but lets see.

contributing/how_to_contribute.rst Outdated Show resolved Hide resolved
contributing/how_to_contribute.rst Outdated Show resolved Hide resolved
contributing/how_to_contribute.rst Outdated Show resolved Hide resolved
contributing/how_to_contribute.rst Outdated Show resolved Hide resolved
contributing/how_to_contribute.rst Outdated Show resolved Hide resolved
MurderVeggie and others added 4 commits July 16, 2024 10:28
Co-authored-by: Hana - Piralein <48352564+Piralein@users.noreply.github.com>
Co-authored-by: Hana - Piralein <48352564+Piralein@users.noreply.github.com>
Co-authored-by: Hana - Piralein <48352564+Piralein@users.noreply.github.com>
Co-authored-by: Hana - Piralein <48352564+Piralein@users.noreply.github.com>
contributing/how_to_contribute.rst Outdated Show resolved Hide resolved
@MurderVeggie MurderVeggie requested a review from skyace65 July 17, 2024 17:39
Copy link
Member

@clayjohn clayjohn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! I left a few suggestions.

When building locally I also noticed there is one more place that needs to be updated:

https://github.com/godotengine/godot-docs/blame/10e686a376ff3c1013fe6f5049c3b80892b5e86f/index.rst#L134
Still says: contributing/ways_to_contribute but it should now be contributing/how_to_contribute. I think this section uses the actual file name, so the redirect doesn't catch it

contributing/how_to_contribute.rst Show resolved Hide resolved
contributing/how_to_contribute.rst Outdated Show resolved Hide resolved
contributing/how_to_contribute.rst Show resolved Hide resolved
contributing/how_to_contribute.rst Outdated Show resolved Hide resolved
contributing/how_to_contribute.rst Outdated Show resolved Hide resolved
contributing/how_to_contribute.rst Outdated Show resolved Hide resolved
MurderVeggie and others added 5 commits July 19, 2024 13:33
Co-authored-by: Clay John <claynjohn@gmail.com>
Co-authored-by: Markus Sauermann <6299227+Sauermann@users.noreply.github.com>
Co-authored-by: Clay John <claynjohn@gmail.com>
removed duplicate link names
updated index.rst
included conversation feedback
Copy link
Member

@AThousandShips AThousandShips left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

To let us know about your findings, fill out this `bug report form <https://github.com/godotengine/godot/issues/new/choose>`_ on our GitHub.
Make sure to include as much information as possible to ensure these issues can easily be reproduced by others.

If you are interested in helping keep our bug tracker organized, you can even join the `bugsquad <https://chat.godotengine.org/channel/bugsquad>`_!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you are interested in helping keep our bug tracker organized, you can even join the `bugsquad <https://chat.godotengine.org/channel/bugsquad>`_!
If you are interested in helping to keep our bug tracker organized, you can even join the `bugsquad <https://chat.godotengine.org/channel/bugsquad>`_!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe language wise the version without "to" sounds smoother, although both are correct.

Copy link
Member

@AThousandShips AThousandShips Jul 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me it sounds ungrammatical, but the whole sentence is a bit clunky, alternatively this:

Suggested change
If you are interested in helping keep our bug tracker organized, you can even join the `bugsquad <https://chat.godotengine.org/channel/bugsquad>`_!
You can even join the `bugsquad <https://chat.godotengine.org/channel/bugsquad>`_ if you want to help keep our bug tracker organized!

To make it flow better

Copy link
Member

@clayjohn clayjohn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks pretty good to me. Let's go ahead and merge it now to avoid endless bikeshedding. We can tweak it in follow up PRs

@MurderVeggie MurderVeggie merged commit 86192a2 into godotengine:master Jul 19, 2024
1 check passed
@MurderVeggie
Copy link
Contributor Author

Merged! Thank you everyone for the extra pairss of eyes. Will make sure to keep this updated from now on.

mhilbrunner pushed a commit that referenced this pull request Jul 24, 2024
Fresh "How to contribute" page

(cherry picked from commit 86192a2)
@mhilbrunner
Copy link
Member

Cherry-picked to 4.2 in #9648.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:contributing Issues and PRs related to the Contributing/Development section of the documentation cherrypick:3.5 cherrypick:3.6 cherrypick:4.1 enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants