Skip to content

Latest commit

 

History

History
39 lines (23 loc) · 1.75 KB

CONTRIBUTING_EN.md

File metadata and controls

39 lines (23 loc) · 1.75 KB
Raw

Contributing to the Project

Thank you for your interest in contributing to this project! Below are the guidelines for contributing effectively.

Code of Conduct

When participating in this project, it is expected that you follow our Code of Conduct. Please read it and respect it in all your interactions.

Issues

If you find a bug or have a suggestion to improve the project, you can open a new issue in the repository. Please provide clear and concise details about the problem or suggestion.

Pull Requests (PRs)

  1. Fork the repository and create a new branch for your changes.
  2. Make your modifications and ensure that the code follows style guidelines and all tests pass.
  3. Write tests for your new or updated code.
  4. Update the documentation if necessary.
  5. Create a pull request from your branch to the main branch of the original repository.
  6. Provide a clear and concise description of your changes.
  7. Ensure that your pull request passes all required tests and code reviews.

Code Style

This project follows Rust's code style guidelines. Please ensure that your contributions adhere to these guidelines.

Tests

All contributions must include tests to ensure code quality. Make sure your tests cover relevant use cases and pass before submitting a pull request.

Documentation

If your contribution involves changes to the documentation, please update it accordingly. Keeping documentation clear and up-to-date is crucial for understanding and maintaining the project.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT LICENSE of the project.

Thank you for your interest in contributing to this project! We look forward to your contributions.