Test that SPEC 3.6 lists every confirmable action

Aberta Para iniciantes
#143 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

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

Direção de pesquisa

Leia apps/api/src/modules/confirmations/domain/confirmation-token.ts para ver o catálogo CONFIRMABLE_ACTIONS e examine a seção 3.6 de docs/SPEC.md. Encontre as convenções existentes para testes unitários e adicione um teste que verifique se cada ação do catálogo é mencionada lá. A tarefa estará concluída quando o teste passar agora e falhar se uma ação fictícia não documentada for adicionada.

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

Descrição

documentation good first issue priority:P3 track:control-plane

CONFIRMABLE_ACTIONS in apps/api/src/modules/confirmations/domain/confirmation-token.ts is the closed catalog of destructive actions that need a confirmation.

Task

Add a unit test that reads docs/SPEC.md and fails when an action of the catalog is not mentioned in section 3.6, so the documentation cannot fall behind the code.

Acceptance

The test passes today and fails if you add a fake action to the catalog without documenting it.

Linguagem predominante
TypeScript
Estrelas
2
Forks
1
Merge médio
7h 17min
PRs com merge (30d)
197

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 shipkeepdev/shipkeep

Todas as issues de shipkeepdev/shipkeep

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.