Thank you for your interest in contributing to this project! Your help is greatly appreciated. Please read the following guidelines to ensure a smooth contribution process.
- Code of Conduct
- How to Contribute
- Reporting Issues
- Submitting Pull Requests
- Coding Standards
- Commit Messages
- License
This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.
- Fork the repository and clone it locally.
- Create a new branch for your feature or bugfix.
- Make your changes with clear, concise commits.
- Test your changes to ensure nothing is broken.
- Submit a pull request with a detailed description.
- Use the issue tracker to report bugs or request features.
- Provide as much detail as possible (steps to reproduce, expected behavior, screenshots, etc.).
- Check for existing issues before submitting a new one.
- Ensure your branch is up to date with
main. - Follow the Coding Standards.
- Include tests for new features or bug fixes.
- Add relevant documentation or update existing docs.
- Reference related issues in your PR description.
- Use clear, descriptive variable and function names.
- Follow Java best practices and conventions.
- Format code using standard Java formatting tools.
- Write comments where necessary for clarity.
- Use the present tense ("Add feature" not "Added feature").
- Be concise but descriptive.
- Reference issues where applicable (e.g.,
Fixes #123).
By contributing, you agree that your contributions will be licensed under the MIT License.
Thank you for helping make this project better!