Skip to content

Latest commit

 

History

History
32 lines (18 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

32 lines (18 loc) · 1.87 KB

Contributing to Thunder Engine

All kinds of contributions are very appreciated, be it documentation, code or build system improvements, be it a small patch, a feature or maybe even becoming a co-maintainer of Thunder Engine. Bug reports and feature requests are of course welcome too!

Reporting a Bug

To report a bug please folow this template

Requesting a Feature

First of all, look around the already open issues to see if the feature was already requested in some form. In that case it's better to comment on the existing feature instead.

To request a feature please folow this template

In any case, be sure to describe the feature in enough detail, to consider its implications on existing parts of the software if relevant and to describe how it would help you in particular. Also, please consider including a mockup if the issue includes UI changes.

Submitting a Patch

  • Ideally, start with something small to get familiar with the review process and work up from there.
  • Make an effort to follow the overal coding style, which is roughly based on the Qt Creator coding style.
  • Be prepared for detailed feedback on your patch and to make several revisions.
  • Each pull request will be built automatically for Windows, Linux and macOS. If the build fails anywhere, please check if it may be a problem with your patch.

Writing Documentation

If you can't a code, but realy like to contribute to project please help us to improve Thunder Engine Documentation

Making a Donation

You can also support further development of Thunder Engine with a monthly donation to Thunder Engine on Patreon.

Thanks a lot for your contribution!