Contributing to Trillek Engine

Flow for Contributing

Fork the repository.
Create a new branch for your feature or bugfix.
Make your changes.
Run tests locally to ensure everything works.
Update documentation if necessary.
Write effective commit messages.
Submit a pull request (PR).
Rebase your branch to master and merge.

For more details, see the Contribution Flow Guide.

Patterns to Use

Use lock guards instead of manual lock/unlock blocks. For more information, see the Coding Patterns page.

What Makes a Good Issue

Provide a clear and concise description of the problem or feature request.
Include steps to reproduce the problem, if applicable.
Attach any relevant screenshots or logs.
Provide information about your environment (OS, version, etc.).
Avoid common mistakes such as vague descriptions or missing information.

Release Schedule

Releases are made on a regular basis, typically every 2-3 months.
Each release includes new features, bug fixes, and improvements.

Additional Resources

For more detailed information and guidelines, please refer to our wiki.

Coding Standards

Comments: Follow the guidelines in the Coding Standards Comments page.
File Structure: Follow the guidelines in the Coding Standards File Structure page.
Indentation and Bracing: Follow the guidelines in the Coding Standards Indentation and Bracing page.
Naming: Follow the guidelines in the Coding Standards Naming page.

Labels for Issues

Use labels like "good first issue" and "help wanted" to indicate issues suitable for new contributors or those seeking help.

Writing Good Pull Requests

Provide a clear and concise description of the changes.
Reference any related issues or pull requests.
Include screenshots or logs if applicable.
Ensure your code follows the project's coding standards.
Avoid common mistakes such as large, unfocused changes or missing tests.

Writing Effective Commit Messages

Use the imperative mood in the subject line (e.g., "Fix bug" instead of "Fixed bug").
Keep the subject line under 50 characters.
Use the body to explain what and why, not how.
Separate the subject from the body with a blank line.
Include references to relevant issues or pull requests.

Running Tests Locally

Set up your local environment according to the project's documentation.
Run the test suite using the provided commands.
Ensure all tests pass before submitting a PR.
If you encounter any issues, refer to the project's documentation or seek help from the community.

Automating the Contribution Process

Consider using GitHub Actions or other CI/CD tools to automate parts of the contribution process.
Set up automated tests to run on every PR.
Automatically format code according to the project's style guidelines.