Skip to content

Latest commit

 

History

History
111 lines (86 loc) · 3.87 KB

CONTRIBUTING.md

File metadata and controls

111 lines (86 loc) · 3.87 KB
Raw

中文Git 开发者文档

如果你是开发人员，想要贡献中文Git，这个开发者文档会告诉你如何开始。

项目结构

中文Git项目的结构如下：

中文Git/
├── zh-tw
├── .gitignore
├── 中文git-pack.py
├── 中文git.exe
├── 中文git.py
├── 中文git更新程序.py
├── 中文git更新程序.exe
├── ABOUT_TRANSLATION.md
├── CONTRIBUTING.md
├── ico.ico
├── LICENSE
├── README_DEV.md
├── README.md
└── USER_HANDBOOK.md
  • zh-tw: 项目的 繁体中文 翻译
  • .gitignore: Git 忽略文件
  • 中文git-pack.py: 中文Git的打包版的主要代码文件，包含了中文Git的核心功能。
  • 中文git.exe: 中文Git的主要代码文件的打包版(使用Pyinstaller打包)，包含了中文Git的核心功能。
  • 中文git.py: 中文Git的主要代码文件，包含了中文Git的核心功能。
  • ABOUT_TRANSLATION.md: 项目的翻译进度展示文件
  • 中文git更新程序.py: 中文Git的打包版的更新代码文件
  • 中文git更新程序.exe: 中文Git的打包版的更新程序(使用Pyinstaller打包)
  • CONTRIBUTING.md(本文件): 开发者文档，用于开发人员了解项目的内部结构和如何贡献。
  • ico.ico: 中文Git 项目图标
  • LICENSE: 开源许可文件(GPL 2.0)
  • README_DEV.md: 项目的详细用户指南，用于向看不惯README.md的用户介绍中文Git
  • README.md: 项目的直白话用户指南，用于向用户介绍中文Git。
  • USER_HANDBOOK.md: 项目的用户手册，用于向用户详细介绍如何使用

本程序按原样提供。

如何开始贡献

欢迎各种形式的贡献，无论是提交bug报告、提出改进建议还是直接提交代码修复问题。以下是贡献步骤：

  1. fork 本项目

  2. 克隆项目到本地：

git clone https://github.com/Your_Github_name/Chinese_git.git
  1. 在新仓库上进行修改。
  2. 提交你的更改：
git add .
git commit -m "描述你的修改"
git push
  1. 提交Pull Request，描述你的修改并等待审核。

报告问题和提出建议

如果你发现了bug或者有任何改进建议，欢迎在GitHub上提交Issues。在提交Issue时，请提供清晰的描述以及复现步骤。建议使用Issue模板提交您的问题。

项目许可

中文Git采用 GPL 2.0 许可证，详情请参阅LICENSE文件。

感谢您的支持和贡献！

如何打包

本项目有两种从py到exe的打包方式：

  1. pyinstaller
    打包命令为:
pyinstaller --onefile -i ico.ico --distpath=. --name=中文git.exe 中文git-pack.py
pyinstaller --onefile -i ico.ico --distpath=. --name=中文git更新程序.exe 中文git更新程序.py
  1. Nuitka
    打包命令为:
python -m nuitka --output-dir=. --show-progress --windows-icon-from-ico=ico.ico --onefile --remove-output 中文git-pack.py
python -m nuitka --output-dir=. --show-progress --windows-icon-from-ico=ico.ico --onefile --remove-output 中文git更新程序.py
  1. 使用AutoPack工具
python AutoPack\AutoPack.py

关于winget包请求

如果你发现最新发行版在winget包中不可用，请向microsoft/winget提交程序清单。
在提交时还请 @DuckDuckStudio / @Luna-Grace ，感谢。
使用winget search DuckStudio.ChineseGit来查找可用源。

关于翻译

如果你希协助 中文Git 进行 繁体中文 本地化，请将您的翻译结果提交到文件夹 zh-tw 内。
对于翻译的要求：

  1. 翻译必须遵循 简体中文 的翻译，除非 简体中文 的翻译出错
  2. 翻译完成后请提交 PR
  3. 在翻译时也请同时翻译README_DEV.md与USER_HANDBOOK.md

已知问题

请见Issues页。