diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ad8412b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,71 @@ +# 贡献指南 | Contributing Guide + +感谢你对本项目的关注!为了保证代码质量和 Review 效率,请在提交 PR 前仔细阅读以下规范。 + +Thank you for your interest! Please read this guide carefully before submitting a PR. + +--- + +## 基本流程 | Basic Workflow + +1. Fork 本仓库并创建功能分支 +2. 在本地完成开发和测试 +3. 提交 PR 并填写清晰的描述 + +--- + +## PR 提交规范 | PR Requirements + +### 1. 一个 PR 只做一件事 | One PR, One Feature + +每个 PR 只包含 **一个功能或一个修复**。多个功能请拆分为多个 PR。 + +Each PR should contain **only one feature or one fix**. Split multiple features into separate PRs. + +### 2. 必须经过验证 | Must Be Verified + +**即使代码是 AI 生成的,也必须在本地运行并验证功能正确。** 未经验证的 PR 将直接关闭。 + +**Even if the code is AI-generated, you must run and verify it locally.** Unverified PRs will be closed. + +### 3. 提供演示截图/视频 | Provide Demo + +PR 中请附上功能演示的 **截图或录屏**,让 Reviewer 快速理解改动效果。 + +Please attach **screenshots or screen recordings** to demonstrate the feature. + +> **隐私提醒:演示中务必对自己的账号信息进行打码处理!** +> +> **Privacy: Always blur/mask your account info in demos!** + +### 4. 禁止大量 JS 注入 | No Excessive JS Injection + +本项目使用 [go-rod](https://go-rod.github.io/) 进行浏览器自动化。**严禁通过大量注入 JavaScript 的方式操作页面元素**,应使用 go-rod 提供的 API 操作元素。 + +违反此规则的 PR **一律不予合并**。 + +This project uses [go-rod](https://go-rod.github.io/) for browser automation. **Do NOT manipulate page elements by injecting large amounts of JavaScript.** Use go-rod's API instead. + +PRs violating this rule **will NOT be merged**. + +### 5. 代码规范 | Code Style + +- Go 代码需要格式化(`gofmt`) +- 注释使用中文,专业术语可用英文 +- 不要过度设计,保持简洁 + +--- + +## 提交 Checklist | PR Checklist + +提交前请确认: + +- [ ] 代码已在本地运行并验证通过 +- [ ] 一个 PR 仅包含一个功能/修复 +- [ ] 附上演示截图或录屏(账号信息已打码) +- [ ] 没有大量 JS 注入,使用 go-rod API 操作元素 +- [ ] 代码已格式化,注释清晰 + +--- + +感谢你的贡献!🎉 | Thanks for contributing! diff --git a/README.md b/README.md index b85a864..71b094c 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ MCP for 小红书/xiaohongshu.com。 - 我的博客文章:[haha.ai/xiaohongshu-mcp](https://www.haha.ai/xiaohongshu-mcp) +> **📌 提交 PR 前必读:[贡献指南 | Contributing Guide](./CONTRIBUTING.md)** + **遇到任何问题,务必要先看 [各种疑难杂症](https://github.com/xpzouying/xiaohongshu-mcp/issues/56)**。 上面的 **疑难杂症** 列表后,还是解决不了你的部署问题,那么强烈推荐使用我写的另外一个工具:[xpzouying/x-mcp](https://github.com/xpzouying/x-mcp),这个工具不需要你进行部署,只需要通过浏览器插件就能驱动你的 MCP,对于非技术同学来说更加友好。 diff --git a/README_EN.md b/README_EN.md index c6c0f51..4211749 100644 --- a/README_EN.md +++ b/README_EN.md @@ -14,6 +14,8 @@ MCP for RedNote (Xiaohongshu) platform. - My blog article: [haha.ai/xiaohongshu-mcp](https://www.haha.ai/xiaohongshu-mcp) +> **📌 Please read before submitting a PR: [Contributing Guide](./CONTRIBUTING.md)** + **If you encounter any issues, be sure to check [Common Issues and Solutions](https://github.com/xpzouying/xiaohongshu-mcp/issues/56) first.** After checking the **Common Issues** list, if you still can't resolve your deployment problems, we strongly recommend using another tool I've created: [xpzouying/x-mcp](https://github.com/xpzouying/x-mcp). This tool doesn't require deployment - you only need a browser extension to drive your MCP, making it more user-friendly for non-technical users.