Add a SECURITY.md and enable private vulnerability reporting

Aberta Para iniciantes
#552 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
72/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
github
Domínio
security

Direção de pesquisa

Comece verificando o README existente do repositório e as configurações de segurança do GitHub. Adicione um SECURITY.md que explique como relatar vulnerabilidades, quais branches são compatíveis (staging e prod) e qual é o prazo esperado para uma resposta; habilite o relato privado de vulnerabilidades nas configurações do repositório. A tarefa estará concluída quando a política estiver disponível na aba Security do GitHub e os relatos privados estiverem habilitados.

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

Descrição

Is your feature request related to a problem? Please describe.
The repository has no SECURITY.md and GitHub's private vulnerability reporting is turned off, anyone who finds a security problem has no private way to report it, so they either open a public issue (which exposes it before a fix) or dont report it at all. I have a potential security issue Id like to share privately.

Describe the solution you'd like

  • Enable private vulnerability reporting (Settings -> Code security -? Private vulnerability reporting) so reports go to gitHub security advisories
  • add a SECURITY.md that says how to report which branch is supported (staging/prod), and roughly how soon reporters can expect a reply

Describe alternatives you've considered
A contact email in the README, but a SECURITY.md is what GitHub links from the Security tab and the "new issue" page

Additional context
GitHub's guide: https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository

Linguagem predominante
TypeScript
Estrelas
22
Forks
66
Métricas de merge de PRs
Nenhum PR com merge em 30d

Preparar o ambiente

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 CodeChefVIT/papers-codechef

Todas as issues de CodeChefVIT/papers-codechef

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.