feat(template): add readme.toml&update README.md#26
Open
Conversation
To adapt to the new v3 architecture
There was a problem hiding this comment.
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 on lines
+4
to
+7
| 1. 请根据课程的具体内容增删仓库的子文件夹。子文件夹建议使用小写英文,如果需要附加说明,则添加 README.md。注意,添加 README 后 .gitkeep 文件仍需保留。 | ||
| 2. 关于课程的描述可以不止以下几个方面,酌情增删。 | ||
| 3. hoa.moe 生成本课程对应页面后,请将页面链接复制到 GitHub 仓库的 About/Website 中。 | ||
| 4. 可以在 GitHub 页面的 About/Topics 中为课程添加话题名称。 |
There was a problem hiding this comment.
既然引入了 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 中为课程添加话题名称。 |
| content = """ | ||
| • 教材: 《书名》 | ||
| • 参考资料链接 | ||
| """ |
| [[lecturers.summary]] | ||
| content = """ | ||
| 建议: 尽早选课,晚了好老师就没了 | ||
| """ No newline at end of file |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
To adapt to the new v3 architecture
📝 描述
✅ 检查清单
我已知晓并认同《参与指南》中的公约。
是否在合适的文件夹上传?
📢 通知成员
🤔 附加信息