贡献指南¶
这本手册由北印信息安全专业的同学共同维护，欢迎提交内容补充或错误修正。
可以贡献什么¶
- 补充内容：某个工具的使用技巧、某个问题的解决方法、某门课的学习心得
- 修正错误：截图过时、步骤有变、链接失效
- 新增章节：你觉得有用但手册还没覆盖的内容
- 改进表达：让某段描述更清晰易懂
如何贡献¶
方式一：提交 Pull Request（推荐）¶
# 1. Fork 本仓库到自己的 GitHub
# （仓库页面右上角点 Fork）
# 2. 克隆到本地
git clone git@github.com:你的用户名/survival-guide.git
cd survival-guide
# 3. 新建分支
git checkout -b add-your-content
# 4. 编辑或新增 docs/ 下的 Markdown 文件
# 本地预览：
pip install mkdocs-material
mkdocs serve
# 5. 提交并推送
git add .
git commit -m "添加：XXX 相关内容"
git push origin add-your-content
# 6. 在 GitHub 上发起 Pull Request
方式二：提 Issue¶
不熟悉 Git 也没关系，在仓库的 Issues 页面描述你想补充或修正的内容，维护者会跟进处理。
写作规范¶
文件命名：使用中文，简洁描述主题，如 CLion配置.md
文件头部：每篇文章以一级标题开头，加一句简短说明
admonition 使用建议：
!!! tip "小技巧"
适合补充建议性内容
!!! warning "注意"
适合标注容易踩坑的地方
!!! info "说明"
适合补充背景知识
!!! note "待补充"
标注内容不完整的区域，欢迎补充
图片：放在 docs/assets/images/ 目录下，使用相对路径引用
内容原则¶
- 实用优先：只写真正用过、验证有效的内容，不抄袭未经验证的教程
- 不放私人信息：API 密钥、账号密码、个人项目文档不属于手册内容
- 保持中立：商业服务的推荐说明选择理由，而不是广告式推荐
- 及时更新：如果知道某个内容已过时，提 Issue 或直接修正
维护者¶
| 角色 | 说明 |
|---|---|
| 发起人 | 星记（信息安全专业在校生） |
| 贡献者 | 所有提交过 PR 的同学 |
感谢每一位贡献者，你的经验可以帮助后来的同学少走弯路。