Wiki维护规范

Wiki 维护规范

一、维护目标

协会 Wiki 用于沉淀协会知识资产,包括组织介绍、学习路线、技术教程、项目文档、竞赛资料和活动归档。

维护 Wiki 的目标是:

  • 让新人更容易入门;
  • 让经验可以传承;
  • 让项目可以复用;
  • 让活动可以追溯;
  • 让协会发展有记录。

二、命名规范

文件名应简洁清晰,例如:

1
2
3
4
C语言学习路线.md
Git与GitHub入门.md
项目文档模板.md
竞赛复盘模板.md

不建议使用:

1
2
3
4
新建文档1.md
最终版.md
最终版2.md
真的最终版.md

三、内容规范

一篇文档建议包含标题、背景、正文、示例、注意事项、参考资料和更新时间。

四、更新规范

  1. 不删除仍有价值的历史内容;
  2. 技术教程应尽量验证可用;
  3. 链接失效应及时替换;
  4. 过时内容应标注;
  5. 重要修改应记录更新说明。

网络安全学习规范

网络安全学习规范

一、基本原则

网络安全学习必须坚持合法、合规、授权、可控的原则。

协会所有网络安全相关学习、训练和实践,应限定在:

  • 本地实验环境;
  • 靶场环境;
  • CTF 比赛环境;
  • 明确授权的测试环境;
  • 课程、科研或比赛允许的实验环境。

严禁将安全技术用于任何未授权攻击、破坏、窃取、扫描、渗透或干扰行为。

二、禁止行为

  1. 未经授权扫描公网或校园网资产;
  2. 未经授权尝试登录他人系统;
  3. 利用漏洞破坏系统或数据;
  4. 窃取账号、密码、Cookie、Token 等敏感信息;
  5. 传播木马、后门、钓鱼页面或恶意程序;
  6. 泄露他人隐私信息;
  7. 将漏洞利用技术用于非法用途;
  8. 在群内传播违法攻击教程、恶意代码或敏感数据。

三、允许的学习场景

  • CTF 题目练习;
  • 本地靶场搭建;
  • Web 安全原理学习;
  • 日志分析;
  • 流量包分析;
  • 授权漏洞复现;
  • 安全报告写作;
  • 防御与修复方案研究。

行为规范

协会行为规范

为了维护良好的学习和交流环境,江苏大学计算机协会成员应遵守以下规范。

一、基本规范

  1. 遵守国家法律法规和学校相关管理规定;
  2. 尊重他人,文明交流;
  3. 不发布违法违规、有害或不当内容;
  4. 不进行人身攻击、恶意嘲讽或歧视性表达;
  5. 不传播谣言和未经证实的信息;
  6. 积极维护协会形象和技术氛围。

二、学习规范

  1. 鼓励主动学习、主动提问、主动分享;
  2. 提问前应先尝试搜索和独立解决;
  3. 提问时应说明问题背景、报错信息、已尝试方法;
  4. 尊重他人时间,不进行无效刷屏;
  5. 分享资料时应注明来源;
  6. 不抄袭他人代码、文档或作品。

三、项目协作规范

  1. 项目分工应明确;
  2. 任务进度应及时同步;
  3. 代码提交应写清说明;
  4. 不随意删除他人代码;
  5. 重要决策应在文档中记录;
  6. 项目结束后应进行复盘。

开源协作规范

开源协作规范

一、为什么要重视开源协作

开源协作可以帮助成员学习真实项目开发流程,包括代码规范、分支管理、Issue 管理、Pull Request、文档维护、版本发布和团队协作。

二、仓库基本结构

1
2
3
4
5
6
7
8
project-name
├── README.md
├── docs
├── src
├── tests
├── .gitignore
├── LICENSE
└── CHANGELOG.md

三、README 应包含

  • 项目名称;
  • 项目简介;
  • 功能介绍;
  • 技术栈;
  • 安装方式;
  • 运行方式;
  • 项目截图;
  • 贡献方式;
  • 开源协议。

四、分支规范

  • main:稳定版本;
  • dev:开发版本;
  • feature/xxx:新功能;
  • fix/xxx:问题修复;
  • docs/xxx:文档修改。

五、提交规范

1
2
3
4
5
6
7
feat: 新功能
fix: 修复问题
docs: 文档修改
style: 格式调整
refactor: 代码重构
test: 测试相关
chore: 构建或杂项

六、Pull Request 规范

提交 PR 前应确认:

  1. 代码能正常运行;
  2. 没有提交无关文件;
  3. 提交说明清楚;
  4. 文档同步更新;
  5. 不影响已有功能。