Contribution

Your contributions are highly valued and appreciated! Our aim is to create an open and transparent environment that facilitates easy and straightforward contributions to this project. This can include reporting any issues or bugs you encounter, engaging in discussions regarding the current codebase, submitting fixes, proposing new features, or even becoming a maintainer yourself. We believe that your input is crucial to the continued growth and success of this framework.

Change request

As we Use Github Flow, So All Code Changes Happen Through Pull Requests.

Pull requests are the preferred method for proposing changes to the codebase, and we adhere to the Github Flow workflow. We welcome all pull requests and encourage you to follow these guidelines when submitting:

  • Fork the repo and create your branch from main.

  • If you’ve added code that should be tested, add tests.

  • If you’ve changed certain functionalities, update the documentation and the test cases if needed.

  • Ensure the test suite passes.

  • Make sure to lint your code.

  • Issue that pull request!

Bug Report

We use GitHub issues to track bugs. Report a bug by opening a new issue.

To ensure that your bug report is complete, please include the following details:

  • A summary of the bug.

  • Step-by-step instructions to reproduce the issue.

  • Your expectations for the outcome.

  • The actual outcome that you experienced.

  • Details regarding the environment setup that you used.

Feature request

We utilize GitHub issues to track feature requests. To request a new feature, please open a feature request.

To help us better understand your feature request, please provide as much detail as possible, such as:

  • A summary of the feature request.

  • Any relevant use cases or scenarios.

  • Any proposed solutions or ideas for implementation.

  • Details regarding the potential impact of the feature.

  • Any other relevant information or context.

License

When you make a contribution, you acknowledge and agree that your contributions will be subject to the MIT License.