Druid-Extension/CONTRIBUTING.md
2025-03-25 22:56:47 +02:00

1.4 KiB

Contribution Guidelines

Hello, Defolder! Thanks for your interest in contributing to the Druid project. It's a massive project that has been around for a long time, and it's still growing. This project has a lot of places where you can help!

Finally, there are set of instructions that will help you to contribute to the project.

Thanks for your help!

Update Documentation

If you see any mistakes in the documentation, you can update it by yourself.

You can push changes to the master branch directly. In case of small fixes, please also update the relative API md files. If there is a lot of changes, I will regenerate them manually.

Issue Reporting

If you find any bugs, please report them to the issue tracker.

Pull Requests

Any pull requests are welcome!

Please, open PR against the develop branch. Very nice to have an issue, which this PR fixes.

You fix should contains only changes, which are related to the issue. Also please keep the code style the same!

Thanks <3

Add or Update Examples

Examples contains a GUI scene, a Druid widget for this GUI. This GUI is included to the examples.gui and the information about examples are added in examples_list.lua file

You can add new examples or update existing ones.

To add new example, you need to create a new folder in the examples directory.