You are awesome! Thank you for considering contributing to LITIENGINE. Before you start, we would like to share a few guidelines for contributions to LITIENGINE with you.
In order to contribute to our project, we expect you to have fully read and agreed to our Code of Conduct.
You can not only support the development of LITIENGINE by contributing code! There are tons of ways to help us maintain the project and keep the community vivid and helpful, a few of which we want to mention here:
Organize LITIENGINE workshops, meetups or game jams
Help us establish a regular LITIENGINE conference
Help community members find the right conferences and submit proposals for speaking
Improve LITIENGINE’s usability by generating class diagrams
Maximize the utiLITI editor's usability by redesigning UI layouts
Help us establishing a style guide to maintain consistency in LITIENGINE's code
Submit LITIENGINE related art to be used on merchandise products
Improve coverage in LITIENGINE's documentation
Start a newsletter for LITIENGINE
Write tutorials, How-To's, and user guides for LITIENGINE
Translate LITIENGINE’s documentation
Link to duplicate issues and suggest new issue labels
Go through open issues and suggest closing old ones
Ask clarifying questions on recently opened issues to move the discussion forward
Find open issues and resolve them
Implement new features
Automate project setup
Help us develop an eclipse plugin for project setup
Improve tooling and testing
Enhance LITIENGINE workflows by improving the utiLITI editor.
Answer questions about LITIENGINE on e.g., our forum, Stack Overflow or Reddit
Answer questions on open issues
Become a moderator for our Github repository or the LITIENGINE forum
Review code on other people’s submissions
Support new contributors and mentor them
Well... if you still want to support us, you could consider helping us bear the development costs for LITIENGINE (e.g. servers and equipment). You can do so by becoming our Patron or donating via Paypal.
Create a Github account
Fork the LITIENGINE repository
Find something you want to work on and create a thematically labelled branch
Commit & Push your changes to the branch
Commits should be logical and atomic units. Commit often!
We expect any new methods that you write to be fully documented
Make sure to also include unit tests for new features
Clean up your code following our style and formatting guide (Which we don't have ready yet. Heh.)
File a Pull Request
We try to review pull requests as often as possible, but don't be mad if it takes us some days before reviewing yours.
As soon as your changes were reviewed and approved, we will merge them into the master branch.
Due to questionable design decisions, violations of our code of conduct, or bugs, we may reject pull requests. Again, this is nothing to be mad about: After you've revised the questionable portions of your pull request, we'll happily review it once more.
Changes resulting in build and test pipeline failures that cannot be resolved within two days will be reverted.
If you want to help in other ways, like hosting workshops or becoming a community moderator, just contact us at email@example.com to specify the details.