Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Norton-Lin authored Jul 4, 2024
1 parent 9ce5c76 commit dffffd8
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,50 @@
# Git--Practive
专用于本团队内部的Git练习

> 练习代码贡献中的 `fork``pull request` 等操作。
## 为仓库贡献代码应当怎么做?

- 注意阅读仓库的 `contributing.md` 文档,它通常位于仓库的根目录或 `docs` 文件夹下。
- 认领 issue
- 开始编码
- 创建 Fork 仓库或同步 Fork 仓库
- 创建或选定分支
- 提交代码
- 创建 Pull Request
- 在 PR 的描述部分中加上 `close #123` (假定你要完成的 issue 编号是 123 的话)

- 等待代码审查

## 练习

> 在练习中提交的内容没有限制,可以是在 `records` 文件夹下提交一个属于自己的 `.md` 文件,也可以是完善本仓库。
>
> 需要注意的是,练习失败的那些产物对于新手来说只能是删掉再来一次。当然你也可以通过提升自己的 git 水平,用一些奇淫巧技拯救此前错误的练习结果。
### 练习一

练习目标:完成第一次提交

注意事项:

- 创建一个 issue,标题命名为 `Ex1``ex1``练习1``练习一`,机器人会将它分配给你,成为你的专属练习 issue
- 记得查看 [`CONTRIBUTING.md`](https://github.com/FrogDar/code-contributing-practice/blob/main/CONTRIBUTING.md) 里的规范(比如 git message 要使用 [`angular` 规范](https://github.com/angular/angular/blob/main/CONTRIBUTING.md)
- 建议自己创建一个分支,并在分支上修改后提交 PR,具体做法和理由见练习二。

### 练习二

练习目标:完成第二次提交

注意事项:

- 创建一个 issue,标题命名为 `Ex2``ex2``练习2``练习二`,机器人会将它分配给你,成为你的专属练习 issue
- 务必保持此次提交不包括上次提交的 git message。

## TODO

- [x] 基本文字介绍
- [x] 完成第一个贡献流程
- [x] 完成一次手动评判
- [x] 利用 `GitHub Actions` 自动评判流程并给予提示
- [ ] 更为充实的文字介绍

0 comments on commit dffffd8

Please sign in to comment.