Become a Godot contributor for Hacktoberfest 2018

By: Rémi Verschelde Oct 01, 2018

October arrived, and with it one of the great community events of the FOSS year, the Hacktoberfest!

This event co-organized by Digital Ocean and GitHub has simple rules: contribute 5 pull requests to open source projects on GitHub, and you will get a cool T-shirt (plus eternal recognition from project maintainers and internal fame in many communities, or something close to that ;)).

And of course, Godot being one of the GitHub-hosted projects, you can work on your Hacktoberfest milestones by contributing directly to Godot's source code or documentation.

Getting started

First of all head to the Hacktoberfest 2018 website and register with your GitHub account (if you haven't one, you'll have to register there too). The Hacktoberfest website has plenty of resources to get you started, and tips on how to find projects that you could be interested in, so make sure to check it in depth.

For Godot specifically, here are relevant links and tips:

Engine contributions

If you want to contribute to the game engine itself by fixing bugs or implementing enhancements (note that new features would be put on hold as we are in feature freeze - you can still make them but you wouldn't get much feedback for now), head to the godotengine/godot repository. Most of the code is C++, with some bits in Objective-C (iOS/macOS), Java (Android) and JavaScript (HTML5).

This is also the place to work on the class reference, the documentation of all nodes available in Godot and their properties and methods.

Here's how to get started:

If you want to work on the class reference, have a look at the dedicated page.

Documentation contributions

To contribute to the online documentation and tutorials, the main repository is godotengine/godot-docs. Note that as mentioned above, contributions to the class reference should instead be done directly in the engine repository (as the class reference is also included offline in the editor).

Here's how to get started:

  • Check the list of issues and see if there's anything you'd like to work on.
  • Review the documentation on how to write documentation (yes, that has to be documented too!).
  • Join the #documentation channel on Godot's Discord server (most active place to discuss with fellow documentation contributors), or if you prefer the #godotengine-doc IRC channel on Freenode (but it's less active).

That's it! It's a lot of links and documentation, but you of course don't need to review everything in depth, look in priority at the contributor's documentation and then pick something you'd like to work on.

Enjoy your Hacktoberfest and have fun contributing to your very own engine!