Skip to content

Commit 4111df1

Browse files
committed
docs: add contributing guidelines in English and Chinese.
Signed-off-by: edmondfrank <[email protected]>
1 parent 77c1aa3 commit 4111df1

File tree

4 files changed

+106
-0
lines changed

4 files changed

+106
-0
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing to Gitee MCP Server
2+
3+
We welcome contributions from the open-source community! If you'd like to contribute to this project, please follow these guidelines:
4+
5+
## Getting Started
6+
7+
1. **Fork the Repository**: Start by forking the repository to your own Gitee account.
8+
2. **Clone the Repository**: Clone the forked repository to your local machine.
9+
```bash
10+
git clone https://gitee.com/your-username/mcp-gitee.git
11+
cd mcp-gitee
12+
```
13+
3. **Create a Branch**: Create a new branch for your feature or bug fix.
14+
```bash
15+
git checkout -b feature/your-feature-name
16+
```
17+
18+
## Making Changes
19+
20+
1. **Code Style**: Follow the existing code style and conventions. Ensure your code is well-documented.
21+
2. **Testing**: Write tests for your changes. Ensure all tests pass.
22+
3. **Commit Messages**: Write clear and concise commit messages.
23+
24+
## Submitting Changes
25+
26+
1. **Push Your Changes**: Push your changes to your forked repository.
27+
```bash
28+
git push origin feature/your-feature-name
29+
```
30+
2. **Create a Pull Request**: Create a pull request from your forked repository to the original repository. Provide a clear description of your changes.
31+
32+
## Code of Conduct
33+
34+
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
35+
36+
## License
37+
38+
By contributing to this project, you agree that your contributions will be licensed under its MIT License.
39+
40+
## Contact
41+
42+
If you have any questions or need further assistance, feel free to reach out to the maintainers.

CONTRIBUTING_CN.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# 为 Gitee MCP 服务器做贡献
2+
3+
我们欢迎开源社区的贡献!如果您想为这个项目做出贡献,请按照以下指南操作:
4+
5+
## 入门
6+
7+
1. **Fork 仓库**:首先将仓库 fork 到您自己的 Gitee 账户。
8+
2. **克隆仓库**:将 fork 的仓库克隆到您的本地机器。
9+
```bash
10+
git clone https://gitee.com/your-username/mcp-gitee.git
11+
cd mcp-gitee
12+
```
13+
3. **创建分支**:为您的功能或 bug 修复创建一个新分支。
14+
```bash
15+
git checkout -b feature/your-feature-name
16+
```
17+
18+
## 进行更改
19+
20+
1. **代码风格**:遵循现有的代码风格和约定。确保您的代码有良好的文档。
21+
2. **测试**:为您的更改编写测试。确保所有测试通过。
22+
3. **提交消息**:编写清晰简洁的提交消息。
23+
24+
## 提交更改
25+
26+
1. **推送您的更改**:将您的更改推送到您的 fork 仓库。
27+
```bash
28+
git push origin feature/your-feature-name
29+
```
30+
2. **创建 Pull Request**:从您的 fork 仓库创建一个 pull request 到原始仓库。提供清晰的更改描述。
31+
32+
## 行为准则
33+
34+
请注意,这个项目发布了一个贡献者行为准则。通过参与这个项目,您同意遵守其条款。
35+
36+
## 许可证
37+
38+
通过为这个项目做出贡献,您同意您的贡献将根据其 MIT 许可证进行许可。
39+
40+
## 联系
41+
42+
如果您有任何问题或需要进一步的帮助,请随时联系维护者。

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,3 +89,14 @@ The server provides various tools for interacting with Gitee:
8989
| **list_issue_comments** | Issue | List comments on an issue |
9090
| **get_user_info** | User | Get current authenticated user information |
9191
| **list_user_notifications** | Notification | List user notifications |
92+
93+
## Contribution
94+
95+
We welcome contributions from the open-source community! If you'd like to contribute to this project, please follow these guidelines:
96+
97+
1. Fork the repository.
98+
2. Create a new branch for your feature or bug fix.
99+
3. Make your changes and ensure the code is well-documented.
100+
4. Submit a pull request with a clear description of your changes.
101+
102+
For more information, please refer to the [CONTRIBUTING](CONTRIBUTING.md) file.

README_CN.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,3 +89,14 @@ Gitee MCP 服务器是一个用于 Gitee 的模型上下文协议(Model Contex
8989
| **list_issue_comments** | Issue | 列出 Issue 的评论 |
9090
| **get_user_info** | 用户 | 获取当前认证用户信息 |
9191
| **list_user_notifications** | 通知 | 列出用户通知 |
92+
93+
## 贡献
94+
95+
我们欢迎开源社区的贡献!如果您想为这个项目做出贡献,请按照以下指南操作:
96+
97+
1. Fork 这个仓库。
98+
2. 为您的功能或 bug 修复创建一个新分支。
99+
3. 进行更改,并确保代码有良好的文档。
100+
4. 提交一个 pull request,并附上清晰的更改描述。
101+
102+
更多信息,请参阅 [CONTRIBUTING](CONTRIBUTING.md) 文件。

0 commit comments

Comments
 (0)