Contribution Guidelines

Thank you for considering contributing to our project! We welcome any contributions that can help improve and enhance the project. Please take a moment to read through the guidelines before making a contribution.

Getting Started

1. Fork the repository.
2. Clone your forked repository to your local machine.
3. Create a new branch for your contribution: git checkout -b your-branch-name

Making Contributions

• Ensure that fmt and clippy is not failing because of your changes.
• Write clear and concise commit messages that describe the purpose of your changes.
• Include any necessary documentation updates for the changes you make.

Submitting Pull Requests

1. Push your changes to your forked repository.
2. Submit a pull request from your feature branch to the main repository's main branch.
3. Include details about the changes you've made and the problem it solves in the pull request description.
4. Make sure none of the CI pipeline checks have failed.

Code Review

• Your pull request will be reviewed by project maintainers.
• Be prepared to address any feedback or suggestions from reviewers.

Maintenance Considerations

• Due to limited maintenance resources, please consider the long-term impact of your contribution on the project's maintainability.
• If your contribution requires ongoing maintenance, be sure to discuss this in your pull request.