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 摘要。