贡献指南
ABP是开源和社区驱动项目. 本指南旨在帮助任何想要为项目做出贡献的人.
贡献代码
你可以将Pull request(拉取请求)发送到Github存储库.
- 从Github克隆ABP存储库.
- 进行必要的更改.
- 发送Pull request(拉取请求).
在进行任何更改之前,请在Github问题上进行讨论. 通过这种方式, 其他开发人员将不会处理同一个问题, 你的PR将有更好的机会被接受.
Bug修复 & 增强功能
你可能希望修复已知Bug或处理计划的增强功能. 请参阅Github上的问题列表.
功能请求
如果你对框架或模块有功能的想法, 请在Github上创建一个问题或参加现有的讨论. 如果它被社区所接受你就可以实现它.
文档翻译
你可能希望将完整的文档(包括本文)翻译成你的母语. 请按照下列步骤操作:
- 从Github克隆ABP存储库.
- 要添加新语言,请在docs文件夹中创建一个新文件夹. 文件夹名称可以是” en”,”es”,”fr”,”tr”等(参见所有文化代码).
- 获取“en”文件夹作为文件名和文件夹结构的参考. 如果要翻译相同的文档, 请保持相同的命名.
- 翻译任何文档后发送拉取请求(PR). 请翻译文件后及时发送PR. 不要等到完成所有文件的翻译.
在ABP文档网站上新添加语言之前,需要翻译一些基本文档:
- 入门文档
- 教程
- CLI
完成了这些基本的翻译后,将添加一种新的语言
资源本地化
ABP框架具有灵活的本地化系统. 你可以为自己的应用程序创建本地化用户界面.
除此之外,框架和预构建模块已经本地化了文本.请参阅Volo.Abp.UI包的本地化文本.
使用 “abp translate” 命令
这是推荐的方法,因为它会自动查找所有缺少的文本的特定文化,让你在一个地方翻译.
- 从Github克隆ABP存储库.
- 安装ABP CLI.
- 在abp仓储的根文件夹为你的语言运行
abp translate -c <culture-name>
命令. 例如对法语使用abp translate -c fr
, 检查文档找到你所用语言的文化代码. - 命令会在同一文件夹下创建
abp-translation.json
文件, 使用你喜欢的编辑器打开这个文件并填写缺少的文本值. - 一旦你完成了翻译,使用
abp translate -a
命令应用更改到相关的文件. - 在GitHub上发送PR.
手动翻译
如果你想更改特定的资源文件,你可以自己找到这个文件进行必要的更改(或为你的语言创建新文件),并在GitHub上发送PR。
博客文章和教程
如果你发布了一些ABP框架的教程或博客帖子, 请通知我们(通过创建Github问题), 我们可能会在官方文档中添加指向你的教程或博客帖子的链接和在推特上公布.
Bug 报告
如果你发现任何Bug, 请在Github存储库上创建一个问题.