Skip to content

docs: 新增 CONTRIBUTING 和 SECURITY - #61

Draft
HoneyBBQ wants to merge 1 commit into
mainfrom
docs/community-files
Draft

HoneyBBQ wants to merge 1 commit into
mainfrom
docs/community-files

Conversation

@HoneyBBQ

@HoneyBBQ HoneyBBQ commented Sep 28, 2026 •

Copy link
Copy Markdown
Collaborator

问题

仓库没有贡献指南,也没有安全策略。贡献者要读 ci.yml 和 mise.toml 才知道 PR 需要通过哪些检查。报告漏洞也没有私密渠道。

改动

  • CONTRIBUTING.md 说明工具链(Go 版本以 go.mod 为准,golangci-lint 版本固定在 mise.toml)、CI 执行的命令和对应的 mise 任务、实时 API 测试的写法和开启方式、Conventional Commit 提交信息格式,以及 PR 流程。
  • SECURITY.md 要求通过 GitHub 私密漏洞报告提交问题,不要开公开 issue,并说明修复在 main 上进行。

验证

  • CONTRIBUTING.md 里的命令与本分支的 .github/workflows/ci.yml 和 mise.toml 一致。
  • SECURITY.md 里的 "Report a vulnerability" 链接要在仓库设置中开启私密漏洞报告后才能用,目前该功能未开启。

⚠️ No human QA

@HoneyBBQ
HoneyBBQ added this pull request to stack #62 September 28, 2026 10:10
@HoneyBBQ HoneyBBQ changed the title docs: add CONTRIBUTING and SECURITY docs: 新增 CONTRIBUTING 和 SECURITY Sep 28, 2026
@HoneyBBQ
HoneyBBQ force-pushed the docs/community-files branch from ea5b83b to 373aa7b Compare September 29, 2026 21:35
Base automatically changed from ci/test-isolation to main September 29, 2026 21:49
@HoneyBBQ
HoneyBBQ force-pushed the docs/community-files branch from 373aa7b to cc7a5a0 Compare September 29, 2026 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant