Skip to content

Latest commit

 

History

History
88 lines (55 loc) · 3.09 KB

File metadata and controls

88 lines (55 loc) · 3.09 KB

贡献指南

本项目欢迎任何形式的贡献!

如果您不了解如何参与开源贡献,您可以参考以下资源:

在提交贡献时,您需要遵守 贡献者公约、当前平台的规则以及当地法律法规。

本地化应用

本地化分为 功能本地化语言本地化 两部分。

功能本地化

当前应用仅支持识别 11 位中国大陆手机号,暂不支持其他类型的号码。如果同时支持识别多种号码可能造成不可预料的结果。

语言本地化

若想为应用添加新的语言支持,请按以下步骤操作:

  1. 定位到 src/vcf_generator_lite/resources/locales 目录。
  2. 创建一个新的语言文件,格式为 <语言代码>[_区域代码].toml(例如:es.tomlpt_BR.toml)。
  3. 参照已有的 en.toml(英文)或 zh_CN.toml(简体中文)文件的结构和键名,翻译对应的值。

提交反馈

如果您在使用中遇到问题或有改进建议,欢迎通过以下任一渠道提交反馈:

参与开发

  1. 确保 GiteeGitHub 中没有相关的拉取请求(PR)。
  2. Fork 本仓库。
  3. 使用 Git 克隆仓库到本地。
  4. 阅读开发指南,熟悉项目开发方法。
  5. 创建分支,如 feature/xxxbugfix/xxx
  6. 编写并提交代码。
  7. 向本仓库提交 PR。

此外,有一些规范规则,请遵守:

代码规范

Python (.py):

  • 函数参数必须声明类型
  • 单行最大 120 字符
  • 其他情况以 PEP8 为准

Markdown (.md):

  • 不限制单行最大字符数
  • 详情请参考 .markdownlint.json
  • 其他情况以 Markdownlint 为准

详情请参考 .editorconfig

文档规范

遵守 中文技术文档写作风格指南

Git 提交规范

遵循 约定式提交

视觉设计

详见 视觉设计