Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

65 lines (41 loc) · 2.99 KB

Contribution Guide

Thank you for your interest in contributing to our project.

Ways to Contribute

There are multiple ways you can contribute to this project:

  1. Report an Issue: If you encounter a bug or have a suggestion, please open an issue on our GitHub Issues page to start the discussion about your proposal.

  2. Open a Pull Request: Contributions are welcome, whether you're fixing a bug, adding a new feature, or improving documentation. You can submit a pull request to our GitHub repository to:

    • Provide a bug fix
    • Add new features or enhancements
    • Improve or expand existing documentation

Report an Issue

Please feel free to raise an issue on GitHub to report misbehavior (i.e. bugs).

Issues are your best way to interact directly with the development team and the community. We encourage you to add implementation suggestions, as this enables the community to collaboratively shape the solutions needed.

We shall be monitoring and responding to issues as best we can. Please attempt to avoid filing duplicates of open or closed items when possible. We use labels to classify and filter issues. See the available set of labels.

Open a Pull Request

We encourage contributions of all sizes, but please keep each contribution focused and independent. We prefer smaller, more manageable pull requests, which makes it easier for us to review, provide feedback, and merge changes quickly.

You can submit a pull request at our GitHub Pull Requests page.

Contribution Process

To make a successful contribution, please follow these steps:

  1. Fork the Repository: Start by forking the repository to your GitHub account.

  2. Make Your Changes:

    • Implement your changes, ensuring that you match the existing coding style and documentation conventions.

    • Write unit tests for your code to ensure it is functional and reliable.

    • If the code in the file is completely generated by AI, please add a minimal transparency comment at the beginning of the file:

      // generated with AI

  3. Write a Clear Commit Message: Write a concise and informative commit message summarizing your changes.

  4. Push to Your Fork: Push your changes to your forked repository.

  5. Submit a Pull Request (PR): Open a pull request against the main repository.

Review Process

Our team will review your proposed changes as soon as possible and provide feedback.

📝 Note: Contributors may use AI-assisted tools when creating code. All contributions must be reviewed and must comply with the project’s license and contribution standards.

Thank you for helping us improve this project! We value your effort and commitment.