CONTRIBUTING.md · Git2Fab/Git4Tome

# 贡献指南

感谢您对**Git4Tome**项目的支持！我们欢迎每一位开发者、翻译者或任何形式的贡献者加入我们的团队，为开源社区贡献力量。

## 1. 贡献方式

我们欢迎各种形式的贡献，包括但不限于：

- **文档翻译**：翻译开源书籍、文章或其他文献，以扩展全球开发者的知识体系。
- **案例贡献**：分享您在开源项目中的实际应用案例、实践经验或解决方案，为社区提供真实的应用场景和技术深度。
- **项目管理**：帮助进行任务分配、管理贡献者以及处理项目中的事务，确保项目顺利进行和协调。
- **知识传播**：将翻译的内容在社区中进行传播，分享至技术论坛、博客、社交媒体等平台，帮助更多开发者接触并学习相关内容。

## 2. 为什么要成为Git4Tome贡献者

我们相信，您的每一次贡献都是对开源世界的宝贵回馈，同时也是自我提升的机会。成为Git4Tome的贡献者，为推动开源文化和技术的发展贡献力量。

- **深入理解开源文化与哲学**：通过参与Git4Tome的翻译工作，你将有机会更深入地了解开源的核心理念和价值观。这不仅仅是对技术的理解，更是对开源背后所蕴含的共享、协作和持续改进精神的领悟。这种深入理解将有助于你在未来的职业生涯中更好地运用开源工具和理念，提升个人技能和价值。
- **构建与分享知识体系**：作为贡献者，你将参与到为中文用户构建一个系统、完整的开源知识体系中来。你的工作将帮助初学者更容易地入门，同时也为进阶用户提供更深入的学习资源。这种知识体系的构建与分享，不仅有助于提升整个中文开源社区的水平，也将使你自身成为知识的传播者和引领者。
- **跨文化交流与融合**：翻译工作本质上是文化和思想的交流与碰撞。在将国际开源社区的内容转化为中文的过程中，你将有机会将全球最佳实践与本土文化相结合，推动开源文化的本土化进程。这种跨文化的交流与融合，将有助于培养你的全球视野和跨文化沟通能力。
- **技能提升与个人成长**：参与开源项目的翻译工作，将极大地提升你的语言能力和专业技术。同时，与来自全球各地的贡献者合作，也将锻炼你的团队协作和项目管理能力。这些技能的提升将有助于你在职业生涯中取得更大的成功。
- **为开源社区贡献力量**：成为Git4Tome的贡献者，意味着你将成为开源社区的一份子，为推动开源文化和技术的发展贡献自己的力量。这种参与感和归属感，将使你更加深入地融入开源社区，与志同道合的伙伴们共同创造更多的可能。

## 3. 如何成为贡献者？

### 3.1 查看翻译项目：

1. 浏览 Git4Tome 项目仓库 的当前翻译项目列表。选择你感兴趣的书籍或文档进行翻译。
2. 翻译指南：
  - 准确性：确保翻译准确无误，并且忠实于原文。
  - 清晰度：使用清晰易懂的中文进行翻译，确保翻译的文本易于理解。
  - 一致性：在整个翻译过程中保持术语和风格的一致性。

### 3.2 代码贡献

我们提供了两种常见的代码贡献方式：**Fork项目并提交PR** 和 **克隆项目并提交PR**。您可以根据个人需求选择合适的方式。

**方式一：Fork项目并提交PR**

Fork项目适用于没有写入权限的贡献者，通过在个人账户上Fork项目、进行修改后提交Pull Request。

1. Fork项目：
  - 访问项目仓库地址:https://gitee.com/git2fab/git4tome
  - 在页面右上角找到并点击“Fork”按钮。
  - 选择将项目Fork到自己的个人Gitee账户。

2. 克隆Fork后的项目到本地：
  - 打开终端或命令提示符。
  - 执行git clone命令，克隆你Fork后的项目。

~~~
git clone https://gitee.com/你的用户名/git4tome.git。
~~~

4. 配置远程仓库

- 进入项目目录，例如：cd git4tome。

~~~
git remote add upstream https://gitee.com/git2fab/git4tome.git
git fetch upstream
~~~

5. 在本地进行修改：

- 进行所需的代码更改。

6. 提交更改到本地仓库：
  - 使用git add命令添加更改的文件，例如：git add文 件名。
  - 使用git commit命令提交更改，例如：git commit -m "提交信息"。

~~~
git add .
git commit -m "描述您所做的更改"
~~~

7. 推送到远程仓库：
  - 使用git push命令将更改推送到你Fork的远程仓库，例如：git push origin 分支名。

~~~
git push origin master  
~~~

8. 创建Pull Request：

- 访问你Fork的项目页面。
  - 点击“创建Pull Request”按钮。
  - 选择你的更改所在的分支和目标分支。
  - 填写PR的标题和描述，然后点击“创建”。

**方式二：克隆项目并提交PR**

克隆项目是指将远程仓库（例如你在GitHub上Fork的项目）的内容下载到你的本地机器上，以便你可以进行本地开发和修改。克隆项目适用于有项目写入权限的贡献者，直接在原仓库进行修改并提交Pull Request。

1. 克隆项目到本地

- 打开终端或命令提示符。
  - 执行git clone命令，克隆原始项目。

~~~
git clone https://gitee.com/git2fab/git4tome.git
cd git4tome
~~~

2. 创建新的分支（可选，但推荐）：
  - 进入项目目录，例如：cd git4tome。
  - 创建并切换到新分支，例如：git checkout -b 分支名。
  - 需要将新分支推送到远程仓库：git push origin 分支名。

~~~
git checkout -b 分支名。
git push origin 分支名。
~~~

2. 在本地进行修改：

- 进行所需的代码更改。

3. 提交更改到本地仓库：
  - 使用git add命令添加更改的文件，例如：git add文 件名。
  - 使用git commit命令提交更改，例如：git commit -m "提交信息"。

~~~
git add .
git commit -m "描述您所做的更改"
~~~

4. 推送到远程仓库：
  - 使用git push命令将更改推送到你Fork的远程仓库，例如：git push origin 分支名。

~~~
git push origin master  
~~~

5. 创建Pull Request：
  - 访问项目的Gitee页面。
  - 点击“创建Pull Request”按钮。
  - 选择你的更改所在的分支和目标分支。
  - 填写PR的标题和描述，然后点击“创建”。

**等待审核与合并**

提交PR后，原仓库的维护者将审核您的更改。他们可能会要求您进行进一步的修改或提供更多信息。一旦更改被接受，维护者会将您的PR合并到原仓库中。

## 4. 行为准则

我们希望所有贡献者遵守以下行为准则：

- 尊重他人：在所有交流中保持尊重和专业的语气。
- 提供建设性反馈：为其他贡献者提供建设性反馈，并且对收到的反馈持开放态度。
- 遵守版权声明：确保所有翻译都是原创的，并且不侵犯他人的权利。

## 5. 贡献协议

在提交拉取请求时，您同意以下事项：

- 您是翻译的原始作者，并且您有权将其提交给本项目。
- 您授予项目维护者使用、修改和分发您的翻译作为本项目一部分的权利。
- 您同意遵守项目的行为准则和贡献指南。

## 6. 贡献者认可

对项目做出重大贡献的贡献者将会被邀请成为具有仓库写入权限的核心贡献者。

## 7. 获取帮助

如果您有任何问题或建议，请通过Gitee上的issue与我们联系，，我们很高兴与您一起交流和协作！

Git2Fab/Git4Tome

简介

发行版

贡献者

近期动态

Git2Fab/Git4Tome .gitee-modal { width: 500px !important; }

简介

发行版

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

近期动态

搜索帮助

Git2Fab/Git4Tome