Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

25 lines (19 loc) · 1.43 KB

How to contribute

Testing and filling issues

If you experience any unexpected behaviour while using godot-ink, please submit a GitHub issue using the appropriate template.
Before your submission, take a minute to make sure your problem hasn't been already reported.

Submitting changes

Please send a GitHub Pull Request with a clear list of what you've done.
Please follow the coding conventions (below) and make sure your commits are split in a sensible way.
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
>
> A description of what changed and its impact."

If your Pull Request is related to another GitHub issue, please reference its #id in your commit log, but refrain from using the closing syntax.

Coding conventions

  • The C# coding style is defined in the .editorconfig file.
  • GDScript code should name everything using snake_case
  • Comments are nice and healthy
  • In general, keep in mind your code will be read by others and should be tidy and nice to look at