Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
150 lines (112 loc) · 3.65 KB

CONTRIBUTING.md

File metadata and controls

150 lines (112 loc) · 3.65 KB

贡献指南 🤝

感谢您对慧译通 - 佛教AI翻译器项目的关注！我们欢迎各种形式的贡献，无论是代码改进、文档完善，还是问题反馈。

🌟 如何贡献

报告问题

  • 使用清晰的标题描述问题
  • 提供详细的重现步骤
  • 包含错误截图或日志（如有）
  • 说明您的操作系统和浏览器版本

功能建议

  • 描述您希望增加的功能
  • 解释为什么这个功能对用户有帮助
  • 如可能，提供具体的使用场景

代码贡献

开发环境设置

# 1. Fork 项目并克隆到本地
git clone https://github.com/YOUR_USERNAME/Buddhist-AI-Translator.git
cd Buddhist-AI-Translator

# 2. 创建功能分支
git checkout -b feature/your-feature-name

# 3. 进行开发
# 修改代码...

# 4. 提交更改
git add .
git commit -m "feat: 添加新功能描述"

# 5. 推送到您的分支
git push origin feature/your-feature-name

# 6. 创建 Pull Request

代码规范

  • 使用有意义的变量名和函数名
  • 添加适当的注释，特别是复杂逻辑
  • 保持代码简洁和可读性
  • 测试您的更改在不同浏览器中的兼容性

文档贡献

  • 改进现有文档的清晰度
  • 添加使用示例和教程
  • 翻译文档到其他语言
  • 更正拼写和语法错误

术语库贡献

我们特别欢迎佛教术语和翻译的贡献：

术语格式

// 在 script.js 的 BUDDHIST_TERMS 对象中添加
"梵文术语": {
    "zh": "中文翻译",
    "en": "English translation",
    "tibetan": "藏文翻译（如有）"
}

术语贡献指南

  • 确保术语的准确性和权威性
  • 提供多语言对照翻译
  • 添加简短的解释或上下文
  • 引用权威佛教文献来源

🏆 贡献者认可

我们会在项目中公开感谢所有贡献者：

代码贡献者

  • 在 README 中列出主要贡献者
  • 在 GitHub Contributors 页面显示

术语库贡献者

  • 在术语数据库中标注贡献者
  • 特别感谢佛学专家的学术贡献

文档贡献者

  • 在相关文档页面标注作者
  • 感谢翻译和本地化工作

📋 Pull Request 指南

提交前检查清单

  • 代码遵循项目的编码规范
  • 已测试新功能或修复的bug
  • 更新了相关文档
  • 提交信息清晰明了
  • 没有引入新的console.log或调试代码

Pull Request 模板

## 变更类型
- [ ] 新功能 (feature)
- [ ] Bug修复 (bugfix)
- [ ] 文档更新 (docs)
- [ ] 样式优化 (style)
- [ ] 代码重构 (refactor)
- [ ] 性能优化 (perf)
- [ ] 测试相关 (test)

## 变更描述
简要描述您的更改...

## 测试
描述您如何测试了这些更改...

## 相关Issue
如果相关，请链接到相关的issue...

## 截图（如适用）
添加截图来帮助解释您的更改...

🤝 社区行为准则

我们的承诺

  • 以慈悲心对待所有参与者
  • 尊重不同的观点和经验
  • 接受建设性的批评
  • 专注于对社区最有利的事情

不可接受的行为

  • 使用不当言论或图像
  • 人身攻击或政治攻击
  • 公开或私下骚扰
  • 未经许可发布他人私人信息

📞 联系方式

如有任何问题或建议，请通过以下方式联系：

🙏 致谢

感谢所有为佛教AI翻译器项目做出贡献的朋友们。您的每一份贡献都在帮助佛法的传播和学术研究的进步。

愿以此功德，回向法界。愿正法久住，利乐有情。 🙏