Thank you for considering contributing to Flame-Route! We welcome contributions from everyone, and we appreciate your help in making this project better.
Please note that this project follows the Contributor Covenant Code of Conduct. By participating in this project, you are expected to uphold this code.
Before contributing, please make sure to discuss any major changes or new features with the project maintainers. This is to ensure that your contributions are aligned with the overall direction of the project.
As we are in an early stage of development, we are currently prioritizing the implementation of features over performance. However, please do your best to ensure that your code is optimized and efficient.
To submit a change, please follow these steps:
- Fork the repository and create a new branch for your changes.
- Implement your changes in the new branch.
- Make sure that your changes are well-tested and do not introduce any new issues.
- Create a pull request with a detailed description of your changes.
As Flame-Route is a performance-critical project, we have some additional guidelines to ensure that code is as optimized as possible:
- Avoid memory allocations wherever possible. Use stack-allocated memory or pre-allocated buffers instead.
- Minimize the use of virtual functions, as they can have a performance impact.
- Use inline functions where appropriate.
- Make sure that your code is free of data races and other thread-safety issues.
Thank you for your interest in contributing to Flame-Route! We look forward to your contributions and appreciate your efforts to help make this project better.