Thank you for considering contributing to TWT - Twitter CLI! This document outlines some guidelines to help you contribute to this project effectively.
Before contributing, please read and adhere to our Code of Conduct. We aim to foster an inclusive and welcoming community for all.
If you encounter any bugs or issues with TWT, please search the issue tracker to see if the issue has already been reported. If not, please open a new issue and provide detailed information about the problem, including steps to reproduce it and any relevant error messages.
We welcome feature requests! If you have an idea for a new feature or improvement, please search the issue tracker to see if it has already been requested. If not, feel free to open a new issue and describe the feature you would like to see.
- Fork the repository and create a new branch for your contribution.
- Make your changes, following the Go coding style and ensuring that your code is well-documented.
- Write tests for your code to ensure its correctness and prevent regressions.
- Run
go testto ensure that all tests pass. - Commit your changes and create a pull request. Please provide a clear and descriptive title for your pull request, along with a detailed description of the changes you've made.
Improvements to documentation are always welcome! If you notice any errors or areas where the documentation could be clearer, please open an issue or pull request with your suggestions.
All contributions will be reviewed by project maintainers. Feedback will be provided, and changes may be requested before your contribution is accepted. We appreciate your patience and understanding throughout the review process.
By contributing to this project, you agree that your contributions will be licensed under the MIT License.