Updated Code of conduct (markdown)

Samuel Dai 2025-04-11 14:29:13 +08:00
parent 20f8bd6dd0
commit 1a2c3ca2ea

@ -31,4 +31,12 @@
- 将你的修补内容以语义为单位分割,而不是功能。譬如说,你可能对一系列 C 风格的代码进行了抽象来重构,但是有时候一时半会儿不能实现原来的功能。这不重要,进行良好的风格重构本身语义上就具有意义。当可以过编译时,将现有的修改直接作为一个 commit 提交也是一个好的选择,后续的功能补丁再通过后续的 commit 完成。这样,可以让他人及时获悉你对接口的基本修改,及时为后续其他方面的开发变更对应的接口抽象。
- 及时在 issue 中反映你开发时遇到的问题,并千万结合你的代码提交。由于代码提交到公共特性分支,他人进行 checkout 检查及及时进行修正的效率会大大提高,整个开发周期最终的以缩短。结合代码提交请通过 GitHub Code Permalink 粘贴,这样可以方便他人跟踪代码变更的上下文。
- 及时在 issue 中反映你开发时遇到的问题,并千万结合你的代码提交。由于代码提交到公共特性分支,他人进行 checkout 检查及及时进行修正的效率会大大提高,整个开发周期最终的以缩短。结合代码提交请通过 GitHub Code Permalink 粘贴,这样可以方便他人跟踪代码变更的上下文。
# Issue
- 尽量说人话,给清楚前因后果、代码上下文,说清楚你想实现的效果 or 遇到的(有问题的)现象
- 也可以将正在开发的内容 or 打算开发的内容列出
- issue 总是应该尽快跟 branch 或 pull request 关联。没有关联的孤儿 issue 会让事务 loss control