CONTRIBUTING.md

Contributing to Velos

Thank you for considering contributing to Velos! Whether it's a bug fix, new feature, or documentation improvement, all contributions are welcome.

Development Workflow

1. Fork the repository and create a feature branch:

   git checkout -b feature/new-feature

2. Write clean, modular code. Velos emphasizes simplicity and flexibility.

3. Follow Coding Conventions:

   • Use PascalCase for Classes and Structs (e.g., EntityManager).
   • Use camelCase for methods and variables (e.g., createEntity()).
   • Prefix private class members with m_ (e.g., m_transform) and static members with s_ (e.g., s_instance).

4. Test your changes in the sandbox example.

5. Submit a pull request with a description of your changes.

Issue Tracking

• Use GitHub issues to report bugs or suggest features.
• Label your issues appropriately:
  • bug, feature, refactor, documentation, ...