Welcome to the contribution guide for CrossPaste. We appreciate your participation and hope your contributions will help us improve the project.
Before you start contributing, you need to set up your development environment.
We welcome various forms of contributions, including but not limited to:
- Reporting bugs
- Submitting feature requests
- Submitting code improvements
- Updating documentation
Steps to contribute:
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
If you find a bug, please submit an issue. Before submitting, ensure the issue hasn't been reported and provide as much detail as possible.
To ensure high-quality code, we have the following pull request guidelines:
- Ensure your code follows the project's coding style (you can run
gradle ktlintFormatto automatically fix some code style issues) - Provide adequate test coverage
- Describe your changes in detail in the pull request description
- Use the project's commit message style
If you have any questions or need further assistance, please contact us:
- Email: [email protected]
- GitHub Issues: link to issues