Skip to content

Commit 92db8aa

Browse files
AHPNFTAHPNFT
committed
Optimize GitHub repository: add Chinese README, issue templates, PR template, contributing guide
1 parent f790d2d commit 92db8aa

8 files changed

Lines changed: 358 additions & 153 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 37 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,46 @@
11
---
2-
name: Bug report
3-
about: Report a problem or unexpected behavior in Clawdbot.
4-
title: "[Bug]: "
2+
name: Bug Report / 问题报告
3+
about: Report a bug to help us improve / 报告问题帮助我们改进
4+
title: '[Bug] '
55
labels: bug
6+
assignees: ''
67
---
78

8-
## Summary
9-
What went wrong?
9+
## Bug Description / 问题描述
1010

11-
## Steps to reproduce
12-
1.
13-
2.
14-
3.
11+
A clear and concise description of what the bug is.
12+
请简要描述问题。
1513

16-
## Expected behavior
17-
What did you expect to happen?
14+
## Steps to Reproduce / 复现步骤
1815

19-
## Actual behavior
20-
What actually happened?
16+
1. Go to '...'
17+
2. Click on '...'
18+
3. See error
2119

22-
## Environment
23-
- Clawdbot version:
24-
- OS:
25-
- Install method (pnpm/npx/docker/etc):
20+
## Expected Behavior / 预期行为
2621

27-
## Logs or screenshots
28-
Paste relevant logs or add screenshots (redact secrets).
22+
A clear and concise description of what you expected to happen.
23+
请描述预期应该发生什么。
24+
25+
## Screenshots / 截图
26+
27+
If applicable, add screenshots to help explain your problem.
28+
如有需要，请添加截图帮助解释问题。
29+
30+
## Environment / 环境信息
31+
32+
- OS: [e.g. Windows 11, macOS 14, Ubuntu 22.04]
33+
- Node.js version: [e.g. 22.14.0]
34+
- OpenX version: [e.g. latest]
35+
36+
## Logs / 日志
37+
38+
```
39+
Paste relevant log output here
40+
请粘贴相关日志
41+
```
42+
43+
## Additional Context / 其他信息
44+
45+
Add any other context about the problem here.
46+
请添加其他相关信息。

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,32 @@
11
---
2-
name: Feature request
3-
about: Suggest an idea or improvement for Clawdbot.
4-
title: "[Feature]: "
2+
name: Feature Request / 功能请求
3+
about: Suggest an idea for this project / 建议新功能
4+
title: '[Feature] '
55
labels: enhancement
6+
assignees: ''
67
---
78

8-
## Summary
9-
Describe the problem you are trying to solve or the opportunity you see.
9+
## Feature Description / 功能描述
1010

11-
## Proposed solution
12-
What would you like Clawdbot to do?
11+
A clear and concise description of what you want to happen.
12+
请描述您希望添加的功能。
1313

14-
## Alternatives considered
15-
Any other approaches you have considered?
14+
## Use Case / 使用场景
1615

17-
## Additional context
18-
Links, screenshots, or related issues.
16+
Describe the scenario where this feature would be useful.
17+
请描述该功能的使用场景。
18+
19+
## Proposed Solution / 建议方案
20+
21+
If you have a solution in mind, please describe it.
22+
如果您有建议的解决方案，请描述。
23+
24+
## Alternatives Considered / 替代方案
25+
26+
A clear description of any alternative solutions or features you've considered.
27+
请描述您考虑过的替代方案。
28+
29+
## Additional Context / 其他信息
30+
31+
Add any other context or screenshots about the feature request here.
32+
请添加其他相关信息或截图。

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Question / 问题咨询
3+
about: Ask a question about OpenX / 咨询 OpenX 相关问题
4+
title: '[Question] '
5+
labels: question
6+
assignees: ''
7+
---
8+
9+
## Question / 问题
10+
11+
A clear description of your question.
12+
请清晰描述您的问题。
13+
14+
## What I've Tried / 已尝试的方法
15+
16+
Describe what you've already tried to solve the problem.
17+
请描述您已经尝试过的方法。
18+
19+
## Environment / 环境信息
20+
21+
- OS: [e.g. Windows 11]
22+
- Node.js version: [e.g. 22.14.0]
23+
24+
## Additional Context / 其他信息
25+
26+
Add any other context here.
27+
请添加其他相关信息。

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## Description / 描述
2+
3+
A clear and concise description of the changes in this PR.
4+
请简要描述此 PR 的更改内容。
5+
6+
## Type of Change / 更改类型
7+
8+
- [ ] Bug fix / 修复 Bug
9+
- [ ] New feature / 新功能
10+
- [ ] Breaking change / 重大更改
11+
- [ ] Documentation update / 文档更新
12+
- [ ] Code refactoring / 代码重构
13+
14+
## Related Issue / 相关 Issue
15+
16+
Fixes # (issue)
17+
18+
## How Has This Been Tested? / 测试情况
19+
20+
Please describe the tests that you ran to verify your changes.
21+
请描述您运行的测试以验证更改。
22+
23+
- [ ] Test A
24+
- [ ] Test B
25+
26+
## Checklist / 检查清单
27+
28+
- [ ] My code follows the style guidelines of this project / 代码符合项目风格
29+
- [ ] I have performed a self-review of my code / 已进行自我审查
30+
- [ ] I have commented my code, particularly in hard-to-understand areas / 已添加必要注释
31+
- [ ] I have made corresponding changes to the documentation / 已更新相关文档
32+
- [ ] My changes generate no new warnings / 更改没有产生新警告
33+
- [ ] I have added tests that prove my fix is effective or that my feature works / 已添加相关测试
34+
35+
## Screenshots (if appropriate) / 截图（如有需要）
36+
37+
Add screenshots here.
38+
请在此添加截图。

‎.github/WELCOME.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# OpenX - 个人 AI 助手
2+
3+
感谢您使用 OpenX！
4+
5+
## 获取帮助
6+
7+
- 📖 [文档](https://docs.openx.bot)
8+
- 🐛 [报告问题](https://github.com/aibgsps-sys/openX/issues)
9+
- 💬 [讨论区](https://github.com/aibgsps-sys/openX/discussions)
10+
11+
## 快速开始
12+
13+
```bash
14+
# Windows 用户：双击 quick-start.bat
15+
# 或手动安装：
16+
git clone https://github.com/aibgsps-sys/openX.git
17+
cd openX
18+
pnpm install && pnpm build
19+
node openx.mjs gateway --dev
20+
```
21+
22+
访问控制台：http://127.0.0.1:18789/ui/

‎CONTRIBUTING.md‎

Lines changed: 71 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,86 @@
1-
# Contributing to openx
1+
# Contributing to OpenX / 贡献指南
22

3-
Welcome to the lobster tank! 🦞
3+
感谢您有兴趣为 OpenX 做出贡献！
44

5-
## Quick Links
6-
- **GitHub:** https://github.com/openx/openx
7-
- **Discord:** https://discord.gg/qkhbAGHRBT
8-
- **X/Twitter:** [@steipete](https://x.com/steipete) / [@openx](https://x.com/openx)
5+
Thank you for your interest in contributing to OpenX!
96

10-
## Maintainers
7+
## 🇨🇳 中文
118

12-
- **Peter Steinberger** - Benevolent Dictator
13-
- GitHub: [@steipete](https://github.com/steipete) · X: [@steipete](https://x.com/steipete)
9+
### 如何贡献
1410

15-
- **Shadow** - Discord + Slack subsystem
16-
- GitHub: [@thewilloftheshadow](https://github.com/thewilloftheshadow) · X: [@4shad0wed](https://x.com/4shad0wed)
11+
1. Fork 本仓库
12+
2. 创建您的特性分支 (`git checkout -b feature/AmazingFeature`)
13+
3. 提交您的更改 (`git commit -m 'Add some AmazingFeature'`)
14+
4. 推送到分支 (`git push origin feature/AmazingFeature`)
15+
5. 创建一个 Pull Request
1716

18-
- **Jos** - Telegram, API, Nix mode
19-
- GitHub: [@joshp123](https://github.com/joshp123) · X: [@jjpcodes](https://x.com/jjpcodes)
17+
### 开发环境设置
2018

21-
## How to Contribute
22-
1. **Bugs & small fixes** �Open a PR!
23-
2. **New features / architecture** �Start a [GitHub Discussion](https://github.com/openx/openx/discussions) or ask in Discord first
24-
3. **Questions** �Discord #setup-help
19+
```bash
20+
# 克隆仓库
21+
git clone https://github.com/aibgsps-sys/openX.git
22+
cd openX
2523

26-
## Before You PR
27-
- Test locally with your openx instance
28-
- Run linter: `npm run lint`
29-
- Keep PRs focused (one thing per PR)
30-
- Describe what & why
24+
# 安装依赖
25+
pnpm install
3126

32-
## AI/Vibe-Coded PRs Welcome! 🤖
27+
# 构建 UI
28+
pnpm ui:build
3329

34-
Built with Codex, Claude, or other AI tools? **Awesome - just mark it!**
30+
# 构建项目
31+
pnpm build
3532

36-
Please include in your PR:
37-
- [ ] Mark as AI-assisted in the PR title or description
38-
- [ ] Note the degree of testing (untested / lightly tested / fully tested)
39-
- [ ] Include prompts or session logs if possible (super helpful!)
40-
- [ ] Confirm you understand what the code does
33+
# 启动开发服务器
34+
node openx.mjs gateway --dev
35+
```
4136

42-
AI PRs are first-class citizens here. We just want transparency so reviewers know what to look for.
37+
### 代码规范
4338

44-
## Current Focus & Roadmap 🗺
39+
- 使用 TypeScript
40+
- 遵循现有的代码风格
41+
- 添加必要的注释
42+
- 编写测试用例
4543

46-
We are currently prioritizing:
47-
- **Stability**: Fixing edge cases in channel connections (WhatsApp/Telegram).
48-
- **UX**: Improving the onboarding wizard and error messages.
49-
- **Skills**: Expanding the library of bundled skills and improving the Skill Creation developer experience.
50-
- **Performance**: Optimizing token usage and compaction logic.
44+
---
5145

52-
Check the [GitHub Issues](https://github.com/openx/openx/issues) for "good first issue" labels!
46+
## 🇺🇸 English
47+
48+
### How to Contribute
49+
50+
1. Fork the repository
51+
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
52+
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
53+
4. Push to the branch (`git push origin feature/AmazingFeature`)
54+
5. Open a Pull Request
55+
56+
### Development Setup
57+
58+
```bash
59+
# Clone the repository
60+
git clone https://github.com/aibgsps-sys/openX.git
61+
cd openX
62+
63+
# Install dependencies
64+
pnpm install
65+
66+
# Build UI
67+
pnpm ui:build
68+
69+
# Build project
70+
pnpm build
71+
72+
# Start development server
73+
node openx.mjs gateway --dev
74+
```
75+
76+
### Code Style
77+
78+
- Use TypeScript
79+
- Follow existing code style
80+
- Add necessary comments
81+
- Write tests
82+
83+
## License / 许可证
84+
85+
By contributing, you agree that your contributions will be licensed under the MIT License.
86+
贡献即表示您同意您的贡献将根据 MIT 许可证进行许可。

0 commit comments

Comments
 (0)