Skip to content

Github07-Python/learngit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

learngit

一个适合公开协作的 Git 学习仓库。

这里不是讲一堆概念的地方,而是一个可以直接上手练习的仓库:

  • 练习 fork
  • 练习新建分支
  • 练习提交 commit
  • 练习发起 Pull Request
  • 练习多人协作与合并

如果你刚开始学 Git,这个仓库就是给你用来“动手”的。

这个仓库适合谁

  • 想第一次体验完整 Git 协作流程的人
  • 想练习 GitHub 提交流程的人
  • 想参与一个低门槛公开仓库的人
  • 想学习如何减少合并冲突的人

参与方式

本仓库采用一个非常简单、也非常适合公开协作的规则:

一人一个文件,只改自己的文件。

请在 contributors/ 目录下新增你的个人文件,例如:

contributors/ronchy.md
contributors/alice.md
contributors/bob-01.md

文件里只需要写两样内容:

# 你的网名

你想留下的一句话。

目录结构

learngit/
├── README.md
├── CONTRIBUTING.md
└── contributors/
    ├── _TEMPLATE.md
    └── ronchy.md

说明:

  • README.md:仓库首页说明
  • CONTRIBUTING.md:贡献规则
  • contributors/:每位参与者自己的文件
  • contributors/_TEMPLATE.md:可参考的模板

参与流程

按下面的顺序参与即可。

1. Fork 这个仓库

先在 GitHub 页面点击右上角的 Fork,把这个仓库复制到你自己的 GitHub 账号下。

2. 先同步你的 Fork

如果你的 Fork 不是刚创建的,建议先同步一次最新代码。

在 GitHub 你的 Fork 页面里,点击:

  • Sync fork
  • Update branch

这样可以确保你本地准备拉取的是最新版本。

3. Clone 你的 Fork 到本地

把你自己账号下的仓库 clone 到电脑:

git clone 你的仓库地址
cd learngit

例如:

git clone https://github.com/your-name/learngit.git
cd learngit

4. 新建一个分支

不要直接在 mastermain 上改,先新建一个分支:

git checkout -b add-your-name

你也可以换成更适合自己的名字,例如:

git checkout -b add-ronchy

5. 添加你的文件

进入 contributors/,新建一个自己的文件:

contributors/your-name.md

内容示例:

# your-name

Hello, Git!

6. 提交修改

先查看一下改动:

git status

然后提交:

git add contributors/your-name.md
git commit -m "add your-name"

7. Push 到你的 GitHub Fork

把你的分支推送到你自己的 GitHub 仓库:

git push origin add-your-name

8. 发起 Pull Request

回到 GitHub,你会看到一个发起 PR 的提示。

点击:

  • Compare & pull request

然后把你的修改提交到原仓库。

PR 标题可以直接写:

add your-name

9. 下一次参与前,先再同步一次

如果你以后还想继续参与,建议每次都先同步你的 Fork,再开始新的修改。

推荐顺序:

  1. 先在 GitHub 页面 Sync fork
  2. 再回本地更新代码
  3. 再新建分支继续修改

本地更新常用命令:

git checkout master
git pull origin master

如果你的默认分支叫 main,就把 master 改成 main

文件命名建议

  • 使用自己的网名、拼音或常用 ID
  • 建议只使用小写字母、数字和 -
  • 不要使用空格
  • 如果重名,可以在后面加数字

例如:

ronchy.md
alice-01.md
hello-git.md

参与示例

你可以参考这个示例文件:

contributors/ronchy.md

也可以直接照着模板写:

contributors/_TEMPLATE.md

贡献规则

提交前请先看这里:

CONTRIBUTING.md

核心规则只有几条:

  • 不改别人的文件
  • 不把内容直接写到根目录
  • 只在 contributors/ 下新增自己的文件
  • 内容保持简单,方便审核和合并

欢迎你留下自己的网名和一句话,完成一次真实的 Git 协作练习。

About

这是Git的学习试验

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors