Contributing to the Engine

First off, thank you for considering contributing to this project! Even if this is not an advanced graphics engine, it provides many opportunities for you to practice and improve your programmin skills. Building an engine will test your math skills (linear algebra and calculus), physics knowledge through physics simulations, algorithms and data structures (expecially for the ECS) and your knowledge of modern programming paradigms. Overall, this is engiene is an easy place to improve your skills.

This guide will help you understand how to contribute effectively.

How to Contribute

Reporting Bugs

If you find a bug in the game engine, please report it by opening an issue. Include as much detail as possible:

• A clear and descriptive title.
• Steps to reproduce the problem.
• Expected and actual behavior.
• Version of the engine you are using.
• Any relevant screenshots or logs.

Suggesting Features

Suggestions for new features or improvements are welcome! To suggest a feature:

• Open an issue with the tag enhancement.
• Provide a clear and concise description of the feature.
• Explain why this feature would be beneficial to the engine.

Contributing Code

If you are ready to contribute code:

• Fork the repository.
• Create a branch for your feature/bugfix: git checkout -b feature/your-feature-name.
• Write clear, concise code, and commit your changes.
• Make sure to add tests if applicable.
• Push the branch to your forked repo.
• Open a pull request against the dev branch with a detailed description of your changes.

License

By contributing, you agree that your contributions will be licensed under the MIT License.