Skip to content

Commit e5349a8

Browse files
xr843xr843
committed
feat: 完善项目文档和推广策略 - 添加许可证、贡献指南、TODO计划、部署配置等
1 parent eb227c3 commit e5349a8

7 files changed

Lines changed: 703 additions & 0 deletions

File tree

‎.github/workflows/deploy.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: 部署到 GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [ main, master ]
6+
pull_request:
7+
branches: [ main, master ]
8+
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: 检出代码
15+
uses: actions/checkout@v3
16+
17+
- name: 设置 Node.js
18+
uses: actions/setup-node@v3
19+
with:
20+
node-version: '18'
21+
22+
- name: 安装依赖
23+
run: |
24+
npm install -g html-minifier-terser
25+
npm install -g clean-css-cli
26+
npm install -g terser
27+
28+
- name: 优化资源
29+
run: |
30+
# 压缩CSS
31+
cleancss -o styles.min.css styles.css
32+
33+
# 压缩JavaScript
34+
terser script.js -o script.min.js -c -m
35+
36+
# 压缩HTML
37+
html-minifier-terser --collapse-whitespace --remove-comments --remove-optional-tags --remove-redundant-attributes --remove-script-type-attributes --remove-tag-whitespace --use-short-doctype --minify-css true --minify-js true -o index.min.html index.html
38+
39+
- name: 部署到 GitHub Pages
40+
uses: peaceiris/actions-gh-pages@v3
41+
if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
42+
with:
43+
github_token: ${{ secrets.GITHUB_TOKEN }}
44+
publish_dir: ./

‎CONTRIBUTING.md‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
# 贡献指南 🤝
2+
3+
感谢您对慧译通 - 佛教AI翻译器项目的关注！我们欢迎各种形式的贡献，无论是代码改进、文档完善，还是问题反馈。
4+
5+
## 🌟 如何贡献
6+
7+
### 报告问题
8+
- 使用清晰的标题描述问题
9+
- 提供详细的重现步骤
10+
- 包含错误截图或日志（如有）
11+
- 说明您的操作系统和浏览器版本
12+
13+
### 功能建议
14+
- 描述您希望增加的功能
15+
- 解释为什么这个功能对用户有帮助
16+
- 如可能，提供具体的使用场景
17+
18+
### 代码贡献
19+
20+
#### 开发环境设置
21+
```bash
22+
# 1. Fork 项目并克隆到本地
23+
git clone https://github.com/YOUR_USERNAME/Buddhist-AI-Translator.git
24+
cd Buddhist-AI-Translator
25+
26+
# 2. 创建功能分支
27+
git checkout -b feature/your-feature-name
28+
29+
# 3. 进行开发
30+
# 修改代码...
31+
32+
# 4. 提交更改
33+
git add .
34+
git commit -m "feat: 添加新功能描述"
35+
36+
# 5. 推送到您的分支
37+
git push origin feature/your-feature-name
38+
39+
# 6. 创建 Pull Request
40+
```
41+
42+
#### 代码规范
43+
- 使用有意义的变量名和函数名
44+
- 添加适当的注释，特别是复杂逻辑
45+
- 保持代码简洁和可读性
46+
- 测试您的更改在不同浏览器中的兼容性
47+
48+
### 文档贡献
49+
- 改进现有文档的清晰度
50+
- 添加使用示例和教程
51+
- 翻译文档到其他语言
52+
- 更正拼写和语法错误
53+
54+
### 术语库贡献
55+
我们特别欢迎佛教术语和翻译的贡献：
56+
57+
#### 术语格式
58+
```javascript
59+
// 在 script.js 的 BUDDHIST_TERMS 对象中添加
60+
"梵文术语": {
61+
"zh": "中文翻译",
62+
"en": "English translation",
63+
"tibetan": "藏文翻译（如有）"
64+
}
65+
```
66+
67+
#### 术语贡献指南
68+
- 确保术语的准确性和权威性
69+
- 提供多语言对照翻译
70+
- 添加简短的解释或上下文
71+
- 引用权威佛教文献来源
72+
73+
## 🏆 贡献者认可
74+
75+
我们会在项目中公开感谢所有贡献者：
76+
77+
### 代码贡献者
78+
- 在 README 中列出主要贡献者
79+
- 在 GitHub Contributors 页面显示
80+
81+
### 术语库贡献者
82+
- 在术语数据库中标注贡献者
83+
- 特别感谢佛学专家的学术贡献
84+
85+
### 文档贡献者
86+
- 在相关文档页面标注作者
87+
- 感谢翻译和本地化工作
88+
89+
## 📋 Pull Request 指南
90+
91+
### 提交前检查清单
92+
- [ ] 代码遵循项目的编码规范
93+
- [ ] 已测试新功能或修复的bug
94+
- [ ] 更新了相关文档
95+
- [ ] 提交信息清晰明了
96+
- [ ] 没有引入新的console.log或调试代码
97+
98+
### Pull Request 模板
99+
```
100+
## 变更类型
101+
- [ ] 新功能 (feature)
102+
- [ ] Bug修复 (bugfix)
103+
- [ ] 文档更新 (docs)
104+
- [ ] 样式优化 (style)
105+
- [ ] 代码重构 (refactor)
106+
- [ ] 性能优化 (perf)
107+
- [ ] 测试相关 (test)
108+
109+
## 变更描述
110+
简要描述您的更改...
111+
112+
## 测试
113+
描述您如何测试了这些更改...
114+
115+
## 相关Issue
116+
如果相关，请链接到相关的issue...
117+
118+
## 截图（如适用）
119+
添加截图来帮助解释您的更改...
120+
```
121+
122+
## 🤝 社区行为准则
123+
124+
### 我们的承诺
125+
- 以慈悲心对待所有参与者
126+
- 尊重不同的观点和经验
127+
- 接受建设性的批评
128+
- 专注于对社区最有利的事情
129+
130+
### 不可接受的行为
131+
- 使用不当言论或图像
132+
- 人身攻击或政治攻击
133+
- 公开或私下骚扰
134+
- 未经许可发布他人私人信息
135+
136+
## 📞 联系方式
137+
138+
如有任何问题或建议，请通过以下方式联系：
139+
140+
- **GitHub Issues**: [提交问题](https://github.com/xr843/Buddhist-AI-Translator/issues)
141+
- **Discussions**: [参与讨论](https://github.com/xr843/Buddhist-AI-Translator/discussions)
142+
- **Email**: （如果您希望添加邮箱联系方式）
143+
144+
## 🙏 致谢
145+
146+
感谢所有为佛教AI翻译器项目做出贡献的朋友们。您的每一份贡献都在帮助佛法的传播和学术研究的进步。
147+
148+
---
149+
150+
**愿以此功德，回向法界。愿正法久住，利乐有情。** 🙏

‎LICENSE‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
MIT License
2+
3+
Copyright (c) 2025 慧译通 - 佛教AI翻译器
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+
23+
---
24+
25+
愿以此功德，普及于一切。我等与众生，皆共成佛道。🙏

‎README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# 慧译通 - 佛教AI翻译器
22

3+
[![GitHub Stars](https://img.shields.io/github/stars/xr843/Buddhist-AI-Translator?style=for-the-badge&logo=github)](https://github.com/xr843/Buddhist-AI-Translator)
4+
[![GitHub Forks](https://img.shields.io/github/forks/xr843/Buddhist-AI-Translator?style=for-the-badge&logo=github)](https://github.com/xr843/Buddhist-AI-Translator)
5+
[![GitHub Issues](https://img.shields.io/github/issues/xr843/Buddhist-AI-Translator?style=for-the-badge&logo=github)](https://github.com/xr843/Buddhist-AI-Translator/issues)
6+
[![License](https://img.shields.io/github/license/xr843/Buddhist-AI-Translator?style=for-the-badge)](LICENSE)
7+
[![Live Demo](https://img.shields.io/badge/Live-Demo-brightgreen?style=for-the-badge&logo=firefox)](https://xr843.github.io/Buddhist-AI-Translator)
8+
9+
> 🙏 **专业的佛教文献AI翻译平台** - 运用现代AI技术促进佛法学术研究与个人修行实践
10+
11+
[🌐 在线体验](https://xr843.github.io/Buddhist-AI-Translator) | [📖 使用指南](#🚀-快速开始) | [🤝 参与贡献](#🤝-开源协作) | [💬 问题反馈](https://github.com/xr843/Buddhist-AI-Translator/issues)
12+
313
## 📸 项目展示
414

515
![项目主界面](image/README/1749601583838.png)

‎TODO.md‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# 开发计划 📋
2+
3+
## 🚀 即将发布的功能
4+
5+
### v1.1 版本
6+
- [ ] **批量翻译功能**：支持上传文档进行批量处理
7+
- [ ] **翻译历史记录**：保存用户翻译历史，支持导出
8+
- [ ] **自定义术语库**：允许用户添加个人术语库
9+
- [ ] **翻译质量评分**：AI自动评估翻译质量
10+
- [ ] **多引擎对比**：同时显示多个AI引擎的翻译结果
11+
12+
### v1.2 版本
13+
- [ ] **OCR功能**：支持图片文字识别翻译
14+
- [ ] **PDF解析**：直接解析PDF文档进行翻译
15+
- [ ] **语音识别优化**：支持更多方言和语音模型
16+
- [ ] **离线术语库**：核心术语支持离线查询
17+
- [ ] **协作翻译**：多人协作校对翻译结果
18+
19+
## 🎯 长期目标
20+
21+
### 技术优化
22+
- [ ] **PWA应用**：支持离线使用和应用安装
23+
- [ ] **多平台客户端**：开发桌面端和移动端应用
24+
- [ ] **API服务**：提供翻译API供第三方调用
25+
- [ ] **插件系统**：支持浏览器插件和编辑器插件
26+
- [ ] **云端同步**：用户数据和设置云端同步
27+
28+
### 内容扩展
29+
- [ ] **更多语言支持**：新增泰文、缅甸文、斯里兰卡文等
30+
- [ ] **专业术语库扩展**：各宗派专门术语库
31+
- [ ] **经典文本库**：内置常见佛教经典对照
32+
- [ ] **注释功能**：为译文添加详细注释和解释
33+
- [ ] **引用功能**：自动生成学术引用格式
34+
35+
### 社区功能
36+
- [ ] **用户系统**：支持用户注册和个人设置
37+
- [ ] **社区论坛**：内置讨论和交流功能
38+
- [ ] **专家审核**：邀请佛学专家审核重要翻译
39+
- [ ] **众包翻译**：社区用户协作翻译项目
40+
- [ ] **学习模式**：佛教语言学习功能
41+
42+
## 🔧 技术债务
43+
44+
### 代码优化
45+
- [ ] **模块化重构**：将代码拆分为更小的模块
46+
- [ ] **TypeScript迁移**：增强代码类型安全
47+
- [ ] **单元测试**：添加完整的测试覆盖
48+
- [ ] **性能优化**：减少包大小和加载时间
49+
- [ ] **无障碍性**：完善ARIA标签和键盘导航
50+
51+
### 基础设施
52+
- [ ] **CI/CD流程**：自动化部署和测试
53+
- [ ] **错误监控**：集成错误追踪系统
54+
- [ ] **性能监控**：用户体验和性能分析
55+
- [ ] **CDN优化**：静态资源CDN加速
56+
- [ ] **多环境部署**：开发、测试、生产环境分离
57+
58+
## 🌟 创新想法
59+
60+
### AI增强功能
61+
- [ ] **智能断句**：AI自动识别最佳断句位置
62+
- [ ] **上下文理解**：基于整段上下文的精准翻译
63+
- [ ] **风格适配**：根据文本类型调整翻译风格
64+
- [ ] **文献溯源**：自动查找术语的文献出处
65+
- [ ] **翻译置信度**：显示AI对翻译结果的置信程度
66+
67+
### 学术研究支持
68+
- [ ] **引文分析**：分析佛教文献中的引用关系
69+
- [ ] **术语演变**：追踪术语在不同时期的变化
70+
- [ ] **比较研究**：不同版本译文的对比分析
71+
- [ ] **统计分析**：文本的词频和概念分析
72+
- [ ] **知识图谱**：构建佛教概念关系图谱
73+
74+
### 用户体验创新
75+
- [ ] **AR翻译**：增强现实即时翻译
76+
- [ ] **语音导读**：智能语音导读经典
77+
- [ ] **沉浸式阅读**：专注模式和护眼模式
78+
- [ ] **个性化推荐**：根据兴趣推荐相关内容
79+
- [ ] **学习路径**：个性化的佛学语言学习路线
80+
81+
## 📊 成功指标
82+
83+
### 用户增长
84+
- [ ] GitHub Stars > 100
85+
- [ ] 月活跃用户 > 1000
86+
- [ ] 每日翻译量 > 500次
87+
- [ ] 社区贡献者 > 20人
88+
89+
### 质量提升
90+
- [ ] 翻译准确率 > 90%
91+
- [ ] 用户满意度 > 4.5/5
92+
- [ ] 术语库规模 > 1000条
93+
- [ ] 支持语言数量 > 25种
94+
95+
### 影响力扩大
96+
- [ ] 学术论文引用 > 5篇
97+
- [ ] 媒体报道 > 10次
98+
- [ ] 合作机构 > 5个
99+
- [ ] 开源项目引用 > 10个
100+
101+
---
102+
103+
## 🤝 如何参与
104+
105+
如果您对以上任何功能感兴趣，欢迎：
106+
107+
1. **提交Issue**：详细描述您的想法和建议
108+
2. **Fork项目**：开始开发您感兴趣的功能
109+
3. **加入讨论**：在Discussions中参与功能设计讨论
110+
4. **贡献代码**：提交Pull Request实现新功能
111+
5. **测试反馈**：帮助测试新功能并提供反馈
112+
113+
**让我们一起构建更好的佛教AI翻译平台！** 🙏

0 commit comments

Comments
 (0)