Skip to content

Latest commit

 

History

History
148 lines (96 loc) · 8.86 KB

README.md

File metadata and controls

148 lines (96 loc) · 8.86 KB
Raw

残酷共学模版

本文档为创建残酷共学的通用模版 - 中文版，请根据模版结构来进行你的残酷共学的内容填充，请将 {} 内容进行替换

{残酷共学名称} logo

介绍

{残酷共学的介绍}

关键词

{残酷共学的关键词 tag，能够让参与者比较快速的搜索和定位到你的这个残酷共学，比如 DeFi，DAO，English 等，请用英文，并用英文的逗号（,）分隔}

面向人群

{残酷共学主要的受众人群，比如是专门针对程序员的，那么没有这方面技能和经验的人就可以不参加}

报名时间

  • 开始时间：{报名开始时间，格式：yyyy-mm-dd，例子：2024-11-01}
  • 结束时间：{报名结束时间，格式：yyyy-mm-dd，例子：2024-11-01}

共学时间

  • 开始时间：{共学正式开始时间，格式：yyyy-mm-dd，例子：2024-11-01}
  • 结束时间：{共学正式开始时间，格式：yyyy-mm-dd，例子：2024-11-01}

发起人

  • 姓名：{残酷共学发起人名字}
  • GitHub ID：{残酷共学发起人 GitHub ID}
  • Telegram：{残酷共学发起人 Telegram ID}
  • Email：{残酷共学发起人 email}

发起组织

  • {残酷共学发起组织方，可以是多个，请按以下格式将组织名称、link 和 logo 填好} LXDAO organization-logo

请假规则

每周请假 {请假次数，数字} 次

社群

Telegram：{残酷共学 Telegram channel 链接，方便大家讨论共学内容}

学习资料/课程安排

{这部分内容是直接用 markdown 格式来编写，默认学习资料是一定要提供的，如果有导师线上上课，需要提供课程安排以及导师信息}

共学激励

{这部分内容是直接用 markdown 格式来编写，激励不是必须的，如果没有激励设置，也可以不写，或者写几句激励的话都可以}

更多信息

{这部分内容是直接用 markdown 格式来编写，也不是必须的，这部分是如果有信息上面模块没有覆盖到，可以写在这里}

报名和打卡规则

因为残酷共学的报名和打卡是基于 GitHub 进行开展的，如果你是非开发者或者对 git 操作不熟悉，请先阅读此文档：残酷共学 GitHub 新手教程

  • 报名:

    • Step01：Fork 本仓库。
    • Step02：复制 Template.md 创建你的个人笔记文件，并根据文档指引填写你的信息，并将文件重命名为你的 GitHub ID：YourGitHubID.md。
    • Step03：创建一个 PR 到当前仓库，本残酷共学助教会对你的 PR 进行 review，review 通过后，你的 PR 会被 merge 到 main 分支，这个时候你会收到邀请加入这个仓库 contribution 的邮件，接受邀请后，你会自动获得 main 分支的 push 权限。
    • Step04：完成以上三个步骤，恭喜你报名成功，后续就可以将你的学习记录直接 push 到 main 分支进行更新。
    • 请加入 xxx 群组保持交流：（请添加你创建的群组链接)。加入群组后请在群里报到一下方便助教记录。

  • 打卡：

    • 报名成功后，你将拥有 main 分支的 push 权限，你需要将每天学习笔记按日期更新到你的 YourName.md 文档中，提交更新后，我们会自动更新你的打卡状态到下面的打卡记录表。
    • 如果你不在 UTC+8 时区，需要添加时区 code 到你的 YourName.md 文件的开始，错误的时区设置可能会使自动化打卡脚本错误计算打卡时间，具体请参考：https://github.com/IntensiveCoLearning/template/blob/main/Template.md?plain=1#L1
    • 当你提交笔记时，请确保以下几点，否则打卡可能会失败：
      • 在 YourName.md 文档，请将笔记内容放到以下代码块中，且 <!-- Content_START --> 和 <!-- Content_END --> 不能删除:
      <!-- Content_START -->
### 日期
笔记内容
<!-- Content_END -->
      • 日期格式为 ### 2024.07.11，请不要随意更改

{本期残酷共学名字}打卡记录表

✅ = Done ⭕️ = Missed ❌ = Failed

Name 6.24 6.25 6.26 6.27 6.28 6.29 6.30 7.01 7.02 7.03 7.04 7.05 7.06 7.07 7.08 7.09 7.10 7.11 7.12 7.13 7.14

如果你是此次共学发起人，请进行以下操作进行自动化发放权限的设置，完成后请将这一部分内容从你的仓库中删掉。

为您的组织 【残酷共学营】 创建具有邀请协作者权限的个人访问令牌

要创建具有邀请协作者权限的个人访问令牌，请按照以下步骤操作：

  1. 导航到您的个人设置: 转到 https://github.com/settings/profile 并登录您的 GitHub 帐户。

  2. 访问个人访问令牌页面: 在左侧菜单中，单击 “开发者设置”，然后选择 “个人访问令牌”。

  3. 创建新令牌: 点击 “生成新令牌” 按钮。选择 classic 的

  4. 命名您的令牌: 在 “令牌名称” 字段中输入一个描述性名称，例如 invite-collaborators。

  5. 选择适当的范围: 在 “范围” 部分，选择授予您的令牌所需的权限。对于邀请协作者，您需要授予以下范围：

  • repo:invite：允许您的令牌创建存储库邀请。最好是给这个令牌赋予 repo 总权限
  • admin:org 权限的用户才能创建具有邀请协作者权限的个人访问令牌。
  1. 将令牌值添加到存储库 secret: 按照上述步骤将您的个人访问令牌值添加到您的存储库 secret 中，并将名称设置为 PAT_WITH_INVITE_PERMISSIONS。

image

配置共学信息配置变量

  1. 配置这四个仓库变量(Repository variables)，注意不要添加换行，空格符号
Field Name Value Comments
START_DATE 2024-06-24T00:00:00+00:00 Start time
END_DATE 2024-07-06T23:59:59+00:00 End time
FIELD_NAME Name Field name in the readme
FILE_SUFFIX .md Shared learning activity number

image