Thank you for considering contributing. Please review the guidelines below before making a contribution.
To ensure that your contributions are considered, please follow this guidelines. Contributions that do not adhere to these guidelines may not be accepted.
Before reporting, please check if an issue with the same content already exists.
When reporting a bug, please include the following information:
- Application version
- Version of the terminal emulator and the OS it's running on
- Information to reproduce the issue
Suggestions are welcome, but any suggestions that do not follow the project's policies are unlikely to be accepted.
Before proposing a new feature, please review the Goals and Non-Goals.
We welcome pull requests, but please note that they are not guaranteed to be accepted. Following this guideline will increase the likelihood of your pull request being approved.
- When creating a pull request, please ensure you follow the same guidelines as mentioned for issues.
- An issue is not required for every pull request. For small or straightforward changes (such as documentation fixes or obvious bug fixes), feel free to open a pull request directly.
- For more complex changes or behavior-altering fixes, opening an issue first is strongly recommended to discuss the approach and avoid unnecessary rework.
- Do not include fixes that are not directly related to the pull request topic.
We use GitHub Actions to perform basic checks:
- Run both stable and MSRV versions of Rust.
- Run build, test, format, and lint.
This project is licensed under the MIT License. By contributing, contributors agree to abide by the terms of the applicable license.
If you have any questions or concerns, please use the Discussions.