贡献指南

开源的核心就是与他人沟通，也就是解决冲突的过程。该指南的初衷就是为初学者提供一个简单的方法去学习以及参与开源项目。

如果你的电脑上未安装 git 或对命令行不熟悉，请参考以下的软件安装。

步骤

flowchart LR
    A[1. fork 组织项目到个人账户] --> B[2. clone 个人远程仓库到本地]
    B --> C[3. 新建特性分支]
    C --> D[4. 进行修改]
    D --> E[5. add 修改到暂存区]
    E --> F[6. commit 更改到本地仓库]
    F --> G[7. push 分支到远程仓库]
    G --> H[8. 创建 Pull Request]
    H --> I{评审通过?}
    I -->|是| J[合并到主分支]
    I -->|否| K[根据反馈修改]
    K --> E

    style A fill:#e1f5fe
    style B fill:#e1f5fe

    style C fill:#ccffcc

    style D fill:#fff3e0

    style E fill:#dff3e0
    style F fill:#dff3e0
    style G fill:#dff3e0

    style I fill:#f3e5f5
    style J fill:#f3e5f5

    style K fill:#fff3e0

1. 打开 github 注册并登录，在想要修改的湖工商仓库页面点击Fork，然后点击Create a new fork，创建分叉到个人仓库。

2.克隆个人仓库（若出现SSL certificate problems请关闭加速器再克隆）：

# 注意：该命令中的 {用户名} 替换为自己的用户名，hutb 替换为想要修改的仓库名，否则没有权限直接修改组织仓库
git clone https://github.com/{用户名}/hutb.git

3.新建特性分支

在命令行窗口中把目录切换到仓库目录（比如.github）

cd .github

接下来使用 git switch 命令新建一个代码分支

git switch -c <新分支的名称>

(新分支的名称一般命名为想要增加的新特性。)

4.修改仓库的文件

打开任意文件，更新文件内容，保存修改。然后使用 git status 列出被改动的文件（后面步骤都可以使用该命令进行状态查看）。

5-7.修改并本地测试没问题后，提交代码到个人仓库（参考 git 命令说明）：

git add README.md
git commit -m "update"
git push origin <新分支的名称>

将 <新分支的名称> 替换为之前新建的分支名称。

如果在 push（推送）过程中出 error（错误），点击这里

- ### Authentication Error

remote: Support for password authentication was removed on August 13, 2021. Please use a personal access token instead.
  remote: Please see https://github.blog/2020-12-15-token-authentication-requirements-for-git-operations/ for more information.
  fatal: Authentication failed for 'https://github.com//first-contributions.git/'

去 [GitHub 的教程](https://docs.github.com/zh/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) 学习如何生成新的 SSH 密匙以及配置。

8. 在自己仓库的首页发现有提交领先于湖工商仓库的main分支，则点击Contribute 创建 Pull Request ，来湖工商仓库做出贡献，创建成功后等待管理员审核通过（如果发现个人仓库落后于湖工商仓库则点击Sync frok以同步其他人的最新修改）。

不久之后，团队成员便会把你所有的变化合并到这个项目的主分支。更改合并后，你会收到一封电子邮件通知。

注意事项： - Pull Request 标题需要概括所修改的内容； - 尽量少包含二进制文件； - 不提交程序能够输出的中间文件、结果文件； - 可以提供少量能够保证程序能够正常运行的示例数据，大的输入数据在 README.md 文件中提供百度网盘或者谷歌网盘的下载链接；

其他

1.如果提交 Pull Request 时出现冲突，则参考使用 TortoiseGit 解决冲突或在 GitHub 上解决合并冲突。

2.同步子模块

git submodule update --remote

3.本地检查Pull requests请求有人发送Pull requests时，可以在 GitHub 上合并之前测试并验证更改。

软件安装

下载相关开发工具，先安装Git-2.40.0-64-bit.exe，再安装可视化工具管理 TortoiseGit-2.14.0.0-64bit.msi（可选）。
git 命令说明；
使用其他工具的教程


Git Bash	Visual Studio 2022	Visual Studio Code	Pycharm

问题

国内访问 github 可能较慢

这里提供 github 加速方案和科学上网的链接。

向 github 上 push 的时候报 403 错误

打开.git/config，比如：

url = https://github.com/OpenHUTB/bazaar.git

将你用户名复制粘贴到github前面再加个@，变成：

url = https://OpenHUTB@github.com/OpenHUTB/bazaar.git

然后就可以进行授权并继续push。

克隆个人仓库出错

若出现SSL certificate problems请关闭加速器再克隆。

git push 报错unexpected disconnect while reading sideband packet

# 增加缓存至4G
git config --global http.postBuffer 4048576000