We welcome contributions to the tiny-frpc project. Whether you're looking to report an issue, submit a bug fix, or propose a new feature, here's how you can contribute.
Before submitting an issue, please check the issue tracker to avoid duplicates. When creating an issue, provide as much relevant information as possible, including:
- A clear and descriptive title
- Steps to reproduce the issue
- Expected behavior
- Actual behavior
- Any relevant logs or error messages
We encourage pull requests from everyone. Here are some guidelines to help you get started:
- Fork the repository and create your branch from
main. - If you've added code, add tests! Ensure the test suite passes.
- If you've changed APIs, update the documentation.
- Ensure your code follows the coding standards used throughout the project.
- Include a clear and detailed description of the pull request.
- Write clean, maintainable, and idiomatic code.
- Follow the Go Code Review Comments for Go code.
- Use meaningful variable names and function names.
- Comment your code where necessary, but prefer self-explanatory code.
- Add unit tests for new features or bug fixes.
- Ensure that your changes do not break existing tests.
- Run the full test suite before submitting your pull request.
Thank you for contributing to tiny-frpc! Your efforts help make the project better for everyone.