57 lines (44 loc) · 2.17 KB

Contributing

I appreciate any and all contributions to this project! Please follow these guidelines to ensure a smooth collaboration.

Reporting Bugs

If you encounter a bug, please open an issue on GitHub with the following information:

A clear and descriptive title
A detailed description of the problem
Steps to reproduce the issue
Any relevant screenshots or error messages
Your environment details (OS, browser, etc.)
The version of the plugin you are using
The version of Godot you are using
Any other relevant information

Suggesting Enhancements

If you have an idea for a new feature or improvement, please open an issue on GitHub with the following information:

A clear and descriptive title
A detailed description of the enhancement
The problem it solves or the benefit it provides
Any relevant screenshots or mockups
How you think it should be implemented
Any other relevant information

You do not need to know how to implement the feature to suggest it.

Please, do not submit pull requests without opening up an issue first.

Pull Requests

If you would like to contribute code, please follow these guidelines:

First, open an issue related to the feature or bug fix you are working on.
Fork the repository and create a new branch for your feature or bug fix.
Write clear, concise commit messages.
Ensure your code is documented and includes comments where necessary.
BEFORE PUSHING: Run ./format.sh to format your code according to the project's style guidelines.
- You will need to have installed
  - gdtoolkit for gdformat and gdlint (See: gdtoolkit)
  - prettier (See: prettier)
  - markdown-cli2 (See: markdown-cli2)
    
    You can also run gdformat ., gdlint ., prettier --write ., or markdownlint ./**/*.md if you are encountering issue with just one of the formatters/linters.
Mention the issue number in your pull request description.

Thanks for contributing! 🐦