Add SECURITY.md, CONTRIBUTING.md and a changelog

Aberta Para iniciantes
  • Algo errado?
#34 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
78/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
typescript
Domínio
documentation

Direção de pesquisa

Leia a seção Contributing em README.md:365-376 e examine os arquivos existentes em .github/. Adicione SECURITY.md com o relato privado de vulnerabilidades do GitHub, mova e amplie as orientações para contribuição em CONTRIBUTING.md e adicione CHANGELOG.md ou esclareça o histórico de versões existente. O trabalho estará concluído quando o perfil da comunidade do GitHub reconhecer a política de segurança e o guia de contribuição, e as orientações solicitadas estiverem documentadas.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
TypeScript
Estrelas
3
Forks
3
Nenhum PR com merge em 30d

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de TMHSDigital/GH-Arcade

Todas as issues de TMHSDigital/GH-Arcade

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.