Skip to content

feat(template): add readme.toml&update README.md#26

Open
IcyDesert wants to merge 1 commit intomainfrom
feat/update-template
Open

feat(template): add readme.toml&update README.md#26
IcyDesert wants to merge 1 commit intomainfrom
feat/update-template

Conversation

@IcyDesert
Copy link
Copy Markdown
Member

To adapt to the new v3 architecture

📝 描述

✅ 检查清单

  • 我已知晓并认同《参与指南》中的公约

  • 是否在合适的文件夹上传?

  • 是否获得了必要的许可?
  • 文件命名是否符合规范?

📢 通知成员

🤔 附加信息

To adapt to the new v3 architecture
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a structured readme.toml file for course metadata and simplifies the README.md template by removing badges and outdated instructions. The review feedback suggests adding instructions for the new TOML file in the README, including a 'Learning Suggestions' section in the TOML template, and adding a trailing newline to the TOML file to comply with standards.

Comment thread README.md
Comment on lines +4 to +7
1. 请根据课程的具体内容增删仓库的子文件夹。子文件夹建议使用小写英文,如果需要附加说明,则添加 README.md。注意,添加 README 后 .gitkeep 文件仍需保留。
2. 关于课程的描述可以不止以下几个方面,酌情增删。
3. hoa.moe 生成本课程对应页面后,请将页面链接复制到 GitHub 仓库的 About/Website 中。
4. 可以在 GitHub 页面的 About/Topics 中为课程添加话题名称。
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

既然引入了 readme.toml 作为课程元数据的存储方式,建议在 README.md 的注释说明中增加一条关于填写 readme.toml 的指导。这样可以确保贡献者在创建新课程仓库时,知道需要维护这个新的元数据文件,以适配 v3 架构。

Suggested change
1. 请根据课程的具体内容增删仓库的子文件夹。子文件夹建议使用小写英文,如果需要附加说明,则添加 README.md。注意,添加 README 后 .gitkeep 文件仍需保留。
2. 关于课程的描述可以不止以下几个方面,酌情增删。
3. hoa.moe 生成本课程对应页面后,请将页面链接复制到 GitHub 仓库的 About/Website 中。
4. 可以在 GitHub 页面的 About/Topics 中为课程添加话题名称。
1. 请根据课程的具体内容增删仓库的子文件夹。子文件夹建议使用小写英文,如果需要附加说明,则添加 README.md。注意,添加 README 后 .gitkeep 文件仍需保留。
2. 请填写 `readme.toml` 中的课程元数据,这是 v3 架构下生成课程页面的重要来源。
3. 关于课程的描述可以不止以下几个方面,酌情增删。
4. hoa.moe 生成本课程对应页面后,请将页面链接复制到 GitHub 仓库的 About/Website 中。
5. 可以在 GitHub 页面的 About/Topics 中为课程添加话题名称。

Comment thread readme.toml
content = """
• 教材: 《书名》
• 参考资料链接
"""
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

建议在 readme.toml 模板中增加“学习建议”等章节示例。目前 README.md 中保留了“学习建议”标题(见 README.md 第 19 行),在 TOML 中提供对应的示例可以引导贡献者将这些内容也结构化,保持两者内容同步。

"""

[[sections]]
title = "学习建议"

[[sections.items]]
content = """
• 建议1
• 建议2
"""

Comment thread readme.toml
[[lecturers.summary]]
content = """
建议: 尽早选课,晚了好老师就没了
""" No newline at end of file
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

文件末尾缺少换行符。建议在文件末尾添加一个换行符,以符合 POSIX 标准并确保各种文本处理工具能正确处理文件结尾。

"""

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant