组织级仓库。它管三件事:
- 组织门面:
profile/README.md渲染在 https://github.com/GQYTeam 首页。 - 组织级默认社区健康文件:仓库缺
CONTRIBUTING.md/SECURITY.md/CODE_OF_CONDUCT.md/ Issue 模板时,GitHub 会回退到本仓库的同名文件。 - 仓库标准与模板:
STANDARDS.md是唯一标准源,standards/templates/是新仓库要复制的模板。
| 路径 | 作用 |
|---|---|
profile/README.md |
组织页 README |
STANDARDS.md |
仓库标准 v1:必备文件、许可、分支、提交、CI 基线 |
standards/LICENSE-body.txt |
PolyForm Noncommercial License 1.0.0 官方全文,不改写 |
standards/templates/STANDARDS.md |
指向 ../STANDARDS.md 的符号链接,便于统一从 standards/ 取标准 |
standards/templates/ |
LICENSE 头、NOTICE、CONTRIBUTING、SECURITY、CHANGELOG、Issue / PR 模板、CI 骨架 |
CONTRIBUTING.md |
组织级默认贡献指南 |
SECURITY.md |
组织级默认漏洞披露流程 |
CODE_OF_CONDUCT.md |
组织级默认行为准则 |
ISSUE_TEMPLATE/、pull_request_template.md |
组织级默认模板 |
scripts/check-org.sh |
组织一致性检查:必备文件齐全 + 组织页链接可达 |
Makefile |
make check |
# 1. 建仓并初始化
gh repo create GQYTeam/gqy-<主题> --public
git init -b main && git remote add origin https://github.com/GQYTeam/gqy-<主题>.git
# 2. 复制标准文件(<REPO> 换成仓库名)
REPO=gqy-<主题>
sed "s/<REPO>/$REPO/g" standards/templates/LICENSE.head > LICENSE
cat standards/LICENSE-body.txt >> LICENSE
sed "s/<REPO>/$REPO/g" standards/templates/NOTICE > NOTICE
cp standards/templates/CONTRIBUTING.md standards/templates/SECURITY.md standards/templates/CHANGELOG.md .
cp standards/templates/editorconfig .editorconfig
cp -R standards/templates/ISSUE_TEMPLATE .github/
cp standards/templates/pull_request_template.md .github/
# 3. 按 STANDARDS.md 自检
make check标准变更走 PR:同一个 PR 里先改 STANDARDS.md,再改 standards/templates/,最后更新 profile/README.md 里受影响的描述。改完在 PR 描述里列出需要跟进的下游仓库。
本组织全部仓库按 PolyForm Noncommercial License 1.0.0 授权:
- 禁止商用。 生产、部署、售卖、SaaS、内置于商业产品等任何商业目的的使用,都不在授权范围内。
- 必须署名。 fork、二次开发、借鉴代码 / 文档 / 设计,都必须标注来源与原作者,并保留
LICENSE、NOTICE与LICENSE顶部的Required Notice:行。
署名格式:
来源项目:GQYTeam/<仓库名>
项目地址:https://github.com/GQYTeam/<仓库名>
原作者:GQYTeam
许可证:PolyForm Noncommercial License 1.0.0