NCU Notes Sharing Wiki

Appearance

贡献指南 ​

感谢你对 NCU Notes Sharing Wiki 的关注！我们欢迎任何形式的贡献，无论是添加新的学习资料、纠正错误、改进内容还是补充信息。

如何贡献 ​

1. Fork 项目 ​

首先，在 GitHub 上 Fork 本项目到你的账户。

2. 克隆到本地 ​

bash
git clone https://github.com/你的用户名/NCU-Notes-Sharing-Wiki.git
cd NCU-Notes-Sharing-Wiki

3. 创建分支 ​

建议为你的修改创建一个新的分支：

bash
git checkout -b your-feature-name

4. 进行修改 ​

对你想添加、纠错、修改或补充的部分进行完善。你可以：

  • 添加新的学习资料：补充教材、笔记、真题等
  • 纠正错误：修正内容中的错误信息
  • 改进内容：优化现有内容的表达和结构
  • 补充信息：添加缺失的信息或更新过时的内容

5. 使用 AI 润色提示词 ​

在提交之前，请使用我们提供的 AI 润色提示词 来优化你的文笔和措辞，确保内容：

  • 表达清晰、准确
  • 符合学术规范
  • 易于理解
  • 风格统一

6. 提交更改 ​

bash
git add .
git commit -m "描述你的修改内容"
git push origin your-feature-name

7. 创建 Pull Request ​

在你的 GitHub Fork 仓库页面，点击 "New Pull Request"，填写：

  • 标题：简洁描述你的贡献
  • 描述：详细说明你做了什么修改，为什么做这些修改
  • 关联：如果修复了某个 issue，请关联它

提交 PR 后，我会尽快查看你的贡献。如果内容合适，我会将其合并到主分支中。

贡献类型 ​

添加学习资料 ​

  • 上传课程相关的 PDF、ZIP、DOC 等文件
  • 在对应的课程页面添加资源链接
  • 确保文件命名清晰，便于识别

纠正错误 ​

  • 修正课程名称、链接错误
  • 修正内容中的错别字、语法错误
  • 更新过时的信息

改进内容 ​

  • 优化文档结构
  • 改进表达方式
  • 添加更多有用的信息

补充信息 ​

  • 添加缺失的课程资料
  • 补充学习路线
  • 添加视频资料链接

注意事项 ​

  1. 保持内容质量：确保添加的内容准确、有用
  2. 尊重版权：不要上传受版权保护的内容，除非你有权限
  3. 文件命名：使用清晰、有意义的文件名
  4. 提交信息：写清楚、有意义的 commit message
  5. 使用 AI 润色：提交前请使用 AI 润色提示词优化内容

感谢 ​

再次感谢你的贡献！每一个贡献都让这个项目变得更好，帮助更多的同学。

如果你有任何问题或需要帮助，请查看 获取帮助 页面。