Skip to content

Latest commit

 

History

History
57 lines (53 loc) · 5.51 KB

journal-rules.md

File metadata and controls

57 lines (53 loc) · 5.51 KB

《GGN_2015 的公开日志规则》

0. 总则

  1. 概述：
    1. 依照《GGN_2015 的日常生活规范》v2024-09-10 中条例 7.1.5 提供的精神指引，GGN_2015 决定编写此文档。
      1. 《GGN_2015 的日常生活规范》请参照 https://github.com/GGN-2015/life_standard
      2. 为了便于公开查阅，本项目中包含了上述项目一个副本 life-standard.md
      3. 2024-10-15 编写 《GGN_2015 的建议性规范合集》 rec-std-index.md
    2. 错误反馈：
      1. 文章中的任何谬误欢迎反馈给 premierbob AT qq.com，您的帮助是对作者莫大的支持。
  2. GGN_2015 编写此日志的主要目的如下：
    1. GGN_2015 认为 “偷摸学习” 是一种在大学中流行的 “迷之” 风气，我们有很多优秀的同学习惯了九年义务教育中的应试教育，认为学习应该是自己一个人的事，对于自己所学内容的公开讨论毫无意义。
      1. GGN_2015 并不否认上述观点，而只是通过自己的行为践行自己的理念，即，交流与讨论是促进知识理解的重要途径。
    2. 在另一方面，GGN_2015 需要一个可追溯、可靠、科学的方式衡量自己到底在学习与生活中投入了多少精力。
      1. 而 git 是一个实现可追溯性的便捷工具，因此 GGN_2015 决定用 git 管理自己的日常笔记，并借助 github 将其公开，以方便他人监督 GGN_2015 的学习情况。
      2. 尽管大多数的同志应该没有无聊到去看 GGN_2015 每天的作息情况，但是 GGN_2015 认为记录这些数据对研究自己的生活习惯颇有帮助。
  3. 此日志中应当包含以下内容：
    1. 日常生活中关于各种知识的讨论的零散记录。
    2. 课业笔记的电子版版本。
    3. GGN_2015 从事学术工作时应当接受来自外界的监督。在严格保证不涉密的前提下，GGN_2015 应当（SHOULD）整理自己在学术相关领域的学习或工作进度，并将其公开。
      1. GGN_2015 不得（MUST NOT）在此日志中提及任何涉密项目相关的内容，包括但不限于涉密项目的名字、研究主题、研究进度。
    4. GGN_2015 每天的入睡时刻、清醒时刻以及睡眠时长。
  4. 此文档中不得（MUST NOT）出现真实的人名（文献引用以及公共出版物作者不属于此类），必要时可以使用以下的方案替代：
    1. 名字的首字母缩写。
    2. 在日常生活中常用的绰号。
    3. GIthub ID、Luogu ID、Codeforces ID。
    4. QQ 昵称、微信昵称。

1. 规范

  1. 文件命名规范：
    1. 此命名规范不约束 README.md 以及 LICENSE 以及所有隐藏文件。
    2. 除上述文件外的所有文件，在命名上必须（SHOULD）严格遵守以下约定：
      1. 文件名中必须（MUST）全部使用半角 ASCII 字符，其中拉丁字母必须为小写。
      2. 文件名必须（MUST）有且仅有一个拓展名，拓展名中必须（MUST）只包含小写字母与数字，
      3. 除拓展名以及与拓展名相邻的点号 "." 外，文件名的其他部分中必须（MUST）只包含小写字母、下划线 "_"、数字以及连字符 "-"。
      4. 同一个文件名中下划线字符至多只能出现一次，且下划线字符前的字串必须为日期表征性信息。
        1. 日期表征性信息指的是：年份 或者 年份-月份 或者 年份-月份-日期
      5. .py 为拓展名的文件如果不符合上述命名约定还可以采用字母数字下划线的字符集组合，这种设计是为了方便相互 import。
    3. 针对课业笔记：
      1. 课业笔记的命名应该（SHOULD）遵循如下格式：%Y-%m-%d_课程代号.md，并被放在名称与课程代号一致的文件夹下。
        1. 课程代号与课程间的对应关系由 GGN_2015 自行决定，同一学期的同一门课程应当（SHOULD）有且只有一个课程代号。
        2. 课程代号中不得（MUST NOT）包含除小写字母、数字以及连字符之外的其他字符。
    4. 针对日常记录：
      1. 应当以月份为单位，分月记录琐事，文件应当被命名为 %Y-%m_misc.md，并被放在名为 misc 的文件夹下。
      2. 有意义的补充文件可以让日常记录变得更加层次分明，在必要时可以（MAY）建立名为 %Y-%m-%d_主题代号.md 的文件。
  2. 文件路径规范：
    1. 所有规则性、项目元信息性文件必须（MUST）被放置在项目根目录下名为 ./data/meta 的目录中。
    2. 所有实质性的日志文件必须（MUST）被放置在项目根目录下名为 ./data/<子项目名> 的目录中。
    3. 除了项目根 README.md 以及 LICENSE 外的所有文件，包括 .md 文件，脚本文件， .pdf 文件等等，在文件树中都必须（MUST）要位于深度恰为 2 的目录中。
    4. 项目中不得（MUST NOT）有任何重名文件，即使这些文件位于不同目录。
    5. 所有有脚本自动生成的文件必须放置于 ./data/auto-gen 目录下。
  3. 渲染流程：
    1. 由于项目中存在脚本生成的文件，因此每当需要上传到网站时，需要遵循以下流程进行生成/渲染。
    2. 首先，关闭所有页面以保证正确保存。
    3. 然后，使用 neko pub_auto_pipeline 脚本完成博客静态文件构建，并推送，并上传 github。