感谢你关注太原理工大学"一生一芯"工作室的前置讲义!这份指南将帮助你快速上手,顺利参与项目。无论是修正错别字还是修复失效链接,这里都有对应的流程与规范。
本讲义基于 VitePress 构建。提交 Pull Request 之前,建议先在本地预览改动效果:
npm install
npm run dev本仓库主要用于归档和维护往期讲义,旨在方便大家复习与查阅。在提交 Issue 或 PR 时,请遵循以下基本原则:
- 客观求实:指出讲义错误时,请尽量说明原因或提供正确的参考资料/出处。
- 友好交流:保持尊重与耐心,就事论事,营造良好的讨论氛围。
| 我可以做的事情 | 具体说明 |
|---|---|
| 捉虫与纠错 | 发现讲义错误,提 Issue 或直接提交 PR 修正 |
| 优化网页前端 | 改进网站样式、功能、交互 |
| 什么都不会但想帮忙 | 检查失效链接、修正错别字 |
哪怕只是顺手改个错别字,也是在为后来的同学“铺路”,感谢你的每一份贡献!
- 先搜索已有 Issues,确认问题未被重复提出。
- 根据内容选择合适的 Issue 模板(Bug 报告 / 内容建议)。
- 问题描述过于简短,缺少必要的上下文。
- 在讲义或搜索引擎中能轻易找到答案的问题。
- 态度恶劣或不尊重他人。
清晰的描述有助于我们更快定位和解决问题,感谢理解!
请勿直接在 main 分支上开发。 始终从最新的 main 创建新分支,推荐按以下前缀命名:
| 前缀 | 用途 | 示例 |
|---|---|---|
feat/ |
新增内容或功能 | feat/git-advanced-notes |
fix/ |
修复 bug 或错误 | fix/deadlink-in-module1 |
docs/ |
文档相关更新 | docs/update-readme |
chore/ |
杂项(配置、依赖等) | chore/update-deps |
我们采用 Conventional Commits 规范,格式为:
<type>(<scope>): <subject>
- type 必须为以下之一:
feat、fix、docs、style、refactor、chore。 - scope(可选)用于说明影响范围,如
notes、config、ui。 - subject 请使用中文简要描述,不超过 50 字,结尾不加句号。
示例:
feat(notes): 添加 Git 进阶笔记
fix(config): 修复导航链接 404 问题
docs(readme): 完善贡献指南
规范的提交信息能让项目历史一目了然,感谢您的配合。