From a051f09325f7d6e0bac72bf0086590e739355b59 Mon Sep 17 00:00:00 2001
From: 0x7fff <4812302+blizard863@users.noreply.github.com>
Date: Sun, 16 Jun 2024 12:37:47 +0800
Subject: [PATCH] Refine README and add CONTRIBUTING guide (#22)

---
 CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++
 README.md       |  5 ++++-
 README_zh.md    |  3 +++
 3 files changed, 46 insertions(+), 1 deletion(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..57235c8
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,39 @@
+# Contributing to tiny-frpc
+
+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.
+
+## Reporting Issues
+
+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
+
+## Pull Requests
+
+We encourage pull requests from everyone. Here are some guidelines to help you get started:
+
+1. Fork the repository and create your branch from `main`.
+2. If you've added code, add tests! Ensure the test suite passes.
+3. If you've changed APIs, update the documentation.
+4. Ensure your code follows the coding standards used throughout the project.
+5. Include a clear and detailed description of the pull request.
+
+## Coding Standards
+
+- Write clean, maintainable, and idiomatic code.
+- Follow the [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments) for Go code.
+- Use meaningful variable names and function names.
+- Comment your code where necessary, but prefer self-explanatory code.
+
+## Testing Requirements
+
+- 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.
+
diff --git a/README.md b/README.md
index 4473b4c..778ae52 100644
--- a/README.md
+++ b/README.md
@@ -87,7 +87,10 @@ Assuming that the domain name 'test-tiny-frpc.frps.com' is resolved to the machi
 # Principle
 ![how tiny frpc works](doc/pic/architecture.png)
 
+# Contributing
+
+We welcome contributions to the tiny-frpc project. If you're interested in helping, you can find the contributing guidelines in our [CONTRIBUTING.md](CONTRIBUTING.md) file. We look forward to your pull requests and issue reports.
 
 # Disclaimer
 
-**This is currently a preview version. Compatibility is not guaranteed. It is presently for testing purposes only and should not be used in production environments!**
\ No newline at end of file
+**This is currently a preview version. Compatibility is not guaranteed. It is presently for testing purposes only and should not be used in production environments!**
diff --git a/README_zh.md b/README_zh.md
index 9f38245..a10a29f 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -91,6 +91,9 @@ HTTP 服务：
 # 原理
 ![how tiny frpc works](doc/pic/architecture.png)
 
+# 贡献
+
+我们欢迎对 tiny-frpc 项目的贡献。如果您有兴趣帮助，请在我们的 [CONTRIBUTING.md](CONTRIBUTING.md) 文件中找到贡献指南。我们期待您的Pull Requests 和 Issue 报告。
 
 # 说明