aceleradora-TW / aceleradora-TW/descarte-certo
Documentação técnica e da arquitetura
- Linguagem predominante
- JavaScript
- Estrelas
- 15
- Forks
- 6
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
Contexto
===
Precisamos oferecer uma documentação mínima para que o sistema possa ser mantido por outros desenvolvedores.
O que incluir?
===
- [x] sumário no README para ficar mais fácil a procura por tópicos
- [x] breve descrição sobre o projeto
- [x] organizar o README: primeiro a descrição, depois ```Tecnologias```, depois ```Como rodar o projeto```, e depois ```Como contribuir```
- [x] incluir ```Pipeline```, ```Como ver logs``` e ```Backend testes``` como sub-tópicos de ```Tecnologias```
O que ajustar?
===
- [x] Nome do banco
- [x] Introdução explicando origem do projeto: 5Marias + Aceleradora Ágil
Onde documentar?
===
README
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Avaliação
Esta issue ainda não foi avaliada.