Thank you for considering contributing to Jetflare! This document outlines guidelines for reporting issues, suggesting enhancements, and submitting pull requests. Following these steps helps maintain project consistency and streamlines collaboration.
- Search for existing issues before submitting a new bug report.
- Provide a clear description of the problem, including steps to reproduce.
- Include screenshots or logs where applicable.
- Use a descriptive title for the issue.
- If you have an idea for an improvement, check if a similar suggestion already exists.
- Provide a detailed explanation of the enhancement and its benefits.
- Use clear examples, mockups, or use cases to illustrate potential impact.
- Fork the repository and create your feature branch (e.g.,
feature/your-feature). - Ensure your code adheres to the project’s coding standards.
- Write tests for your changes, where applicable.
- Open a pull request against the main branch with a clear description of your changes.
- Engage in discussion and respond to review comments promptly.
- Keep code clean, readable, and well-commented.
- Follow existing project conventions for naming, formatting, and documentation.
- Write modular code and avoid unnecessary complexity.
- Ensure backward compatibility and include tests for new features.
- Update and maintain documentation alongside code changes.
- Ensure that any new features are well documented in this and/or other relevant documentation files.
- Use clear and concise language that is accessible to all contributors.
By contributing, you agree that your contributions will be licensed under the project's chosen license.
Thank you for contributing to Jetflare! Your help is greatly appreciated and vital to the success of this project.