aceleradora-TW / aceleradora-TW/descarte-certo
Documentação técnica e da arquitetura
- Dominant language
- JavaScript
- Stars
- 15
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
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
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.