Add SECURITY.md, CONTRIBUTING.md and a changelog

未关闭 适合新手
  • 哪里不对？
#34 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
78/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
typescript
领域
documentation

调研方向

阅读 README.md:365-376 中的 Contributing 部分，并检查 .github/ 下现有的文件。添加 SECURITY.md，说明如何通过 GitHub 私下报告漏洞；将贡献指南移至 CONTRIBUTING.md 并加以扩充；添加 CHANGELOG.md 或澄清现有的发布历史。完成标准是 GitHub 的社区资料页识别出安全政策和贡献指南，并且所要求的指南内容已记录在文档中。

由索引模型根据 Issue 内容生成。

描述

documentation good first issue severity: low

Summary

The repo invites pull requests but has no CONTRIBUTING, SECURITY, CHANGELOG, code of conduct or issue and PR templates. Contribution guidance is a short README section.

Where

  • README.md:365-376
  • .github/ (only workflows/ and assets/)

Suggested fix

  • Add a short SECURITY.md pointing to GitHub private vulnerability reporting
  • Move the Contributing section into CONTRIBUTING.md and add npm run typecheck, the scene-key convention, the procedural-art rule and thumbnail expectations
  • Add a CHANGELOG.md, or state that the roadmap and commit log serve that purpose

Acceptance criteria

  • GitHub's community profile shows a security policy and contributing guide

Getting started

  • Relevant files: README.md
  • Run locally: npm install, then npm run dev
  • Checks: npm run typecheck and npm run build (there is no test suite yet)
  • Related docs: README.md

Filed by repo-audit/full-audit at b001f5d. Severity: low. Effort: S. audit-key: documentation|README.md|community-files

主要语言
TypeScript
星标
3
派生
3
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

TMHSDigital/GH-Arcade 的其他 Issue

查看 TMHSDigital/GH-Arcade 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。