First off, thank you for considering contributing to this project. It's people like you that make the open-source community such an incredible environment to learn, inspire, and create.
By participating in this project, you are expected to uphold our Code of Conduct. Please report unacceptable behavior to the project maintainers.
Before creating bug reports, please check the existing issues to avoid duplicates. When you are creating a bug report, please include as many details as possible:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible.
- Provide specific examples to demonstrate the steps.
- Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
- Explain which behavior you expected to see instead and why.
Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please provide:
- A clear and descriptive title.
- A step-by-step description of the suggested enhancement in as many details as possible.
- Specific examples to demonstrate the steps.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Fill in the required template.
- Do not include issue numbers in the PR title.
- Ensure your code adheres to the existing styling and conventions of the project.
- Include comments in your code where appropriate, especially for complex logic.
- Update the documentation if your changes require it.
- Make sure your PR passes all required CI/CD checks before requesting a review.
- Use the present tense ("Add feature" not "Added feature").
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
- Limit the first line to 72 characters or less.
- Reference issues and pull requests liberally after the first line.
Thank you for your contributions!