key-lang
key-lang copied to clipboard
[建议] 使用 Github 的一些特性来更好的维护本项目的 git 记录
- 本项目并没有做过 issue 与 commit 记录 / issue 与 pull requrest 记录的联动,这点属实不应该。比如 issue #3。
原因:这更像是一个基础的原则性问题。因为所有的项目,既然开源,在作者做出指向性修改的时候,都应该标定修改的位置,并在问题界面提供明确的入口,方便其他人进行 review,以及其他的操作。
修改建议:在进行 commit 的时候,加入 issue 编号来标定该 commit 用于修复哪项 issue。
- 本项目疑似没有进行 main branch protect。建议开启。
原因:我承认,在单人进行开发的时候,可能开启 main branch protect 并采取 branch merge 听上去有点自娱自乐,但是事实上这个能帮助你更好的进行版本控制。假如你后续写了两个功能,先写的功能 A 再写的功能 B,然后再加入一个功能 C 发现功能 A 会导致功能 C 出现问题,如果需要 revert 排查,使用 branch merge 就可以迅速的帮你关闭功能 A。按照你现有的方法,出现 bug 时回滚会导致功能 B 一块下线。修复结束后再加入功能 B 则会污染现有的 git 记录。
修改建议:开启 main branch protect 并在后续的开发中采取开 branch 开发的模式。
- 本项目的 README 过于简略。
原因:一个好的 README 应该绝不只是包含你认为你写的程序的特色,对于编程语言类库而言,可以参考 wenyan-lang/wenyan 项目。他们的 README 是非常用语言 README 中我认为最好的一个。
修改建议:你自己看着改。