Contributing Guidelines

Thank you for your interest in contributing to this project! We're excited to collaborate with you. To ensure a smooth process, please follow the guidelines below:

How to Contribute

  1. Report Bugs: If you discover a bug, please check existing issues first to ensure it hasn't been reported. If not, create a new issue and include detailed steps to reproduce the bug.
  2. Suggest Features: We welcome feature suggestions! Please create a detailed issue describing the feature and its benefits.
  3. Submit Code: Contributions in the form of code are welcome! To get started:
    • Fork the repository and clone it locally.
    • Create a new branch for your work (e.g., feature/your-feature-name).
    • Commit your changes with clear and descriptive messages.
    • Push your branch and submit a pull request.

Code of Conduct

All contributors are expected to adhere to our Code of Conduct. Be respectful and constructive in your communication.

Code Style

  • Follow the existing coding style and conventions of the project.
  • Ensure your code is clean and well-documented.
  • Test your changes thoroughly before submitting.

Pull Request Process

  1. Ensure your branch is up-to-date with the main branch.
  2. Describe the purpose of your pull request clearly in the description.
  3. Link related issues (if applicable) and explain how your PR resolves them.
  4. Ensure all checks pass and include unit tests if applicable.

Issues and Labels

  • Use relevant labels when creating or updating issues (e.g., bug, enhancement, documentation).
  • If you’re unsure how to label an issue, the maintainers will assign appropriate labels.

Tests

  • Include tests to cover new features or bug fixes.
  • Ensure all existing tests pass before submitting your contribution.

License

By contributing to this repository, you agree that your contributions will be licensed under the repository's license.