Skip to content

Latest commit

 

History

History
28 lines (24 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

28 lines (24 loc) · 2.2 KB

Contributing

Here are the rules if you want to contribute to this repository.

  1. You should first open an issue describing the changes you want. You should also mention that you want to open a pull request.
  2. One feature per issue/PR. It makes reviewing and merging easier.
  3. When writing code, make sure to follow the style guide.

GDScript style guide

It's basically this but with a few changes.

Summary

  1. Use snake_case for variable names, functions and signals.
  2. Signals should be in the past tense.
  3. Nodes, classes and file names should use PascalCase.
  4. Use 2 newlines between functions, unless they are short.
  5. Use static typing as much as you can.

Adding a new language

  1. Open an issue with the localization label.
  2. Download this spreadsheet and add your translations.
  3. Export to CSV. I recommend Google Sheets or LibreOffice. Microsoft Excel doesn't support UTF-8 encoding.
  4. Fork this repository and then clone your fork. If you don't want to clone it or download Godot, you can skip steps 7 and 8 and modify these files manually: languages/text.csv, languages/text.csv.import and project.godot. See this commit and this one (ignore line 87).
  5. Replace languages/text.csv with the file you exported.
  6. Open the project with the Godot version mentioned in this file.
  7. In the top left, Project > Project Settings > Localization > Add > Select the language you added.
  8. Commit and push the changes to your fork.
  9. That's it. Now all you have to do is open a Pull Request which mentions that it fixes the issue you opened (e.g. Fixes #10).
  10. Optional: If you want to update the translation whenever there are changes, I suggest subscribing to this discussion.