LanXi387 / game-Toolbox

一个简洁的游戏网址工具箱
GNU General Public License v3.0
2 stars 2 forks source link

How to use GitHub guides #1

Open Muska-Ami opened 2 months ago

Muska-Ami commented 2 months ago

本 Issue 不是一个问题报告,但我认为有必要。本 Issue 能帮助您更好的使用 GitHub 。 这不是一个官方发送的 Issue ,而是本人自愿编写。

关于代码文件

我们来观察一下你的代码文件和提交消息: image

可以看到,你的代码提交全部是手动通过 GitHub Add file via upload 或者在线编辑功能上传的。事实上,我认为 GitHub 的 Web 编辑并不符合这个平台代码提交的初衷,只是为了方便临时的修改。

正确的做法是通过 Git 这样的 版本控制系统(VCS) 来提交代码,并推送到仓库。

并且,你是否发现,你的文件列表出现了这样的情况: image

事实上,这样做是 完全错误 的。

顾名思义,这个平台叫做 GitHub ,那么它就是使用 Git 来实现 版本管理 功能的。 所以,你的每一个 提交(commit) 都会被记录,并可以被查询。比如: image

这样,就可以查询到你在 f0c579c(f0c579c23323cddab98dc3661f9f0f888ce7f67b) 这个 commit 时的代码,也就是你不需要每个版本都上传,只需要更新一个文件,这样不仅是符合规范的,同时也便于查询代码更改,比如前面的 f0c579c23323cddab98dc3661f9f0f888ce7f67b ,点进去就可以看到 差异(diff) 信息。

关于语法

我发现你的 Release 里面的更新信息,使用了如下的格式:

+第一个更新
+第二个更新

事实上,你可以使用 Markdown 列表:

<!-- 无序列表 -->
- 第一个更新
- 第二个更新

<!-- 有序列表 -->
1. 第一个更新
2. 第二个更新

记住,在大多数代码共享平台,你都可以使用类似的 Markdown 语法。

关于 Markdown 语法指南,请查阅 GitHub Markdown。这里列出了 GitHub 支持的 Markdown 语法。

关于其他的不一一赘述,如果你想用好这个平台,请熟读 GitHub Docs

ltzXiaoYanMo commented 2 months ago

🤔

daizihan233 commented 2 months ago

🤓