Add technical docs structure
This commit is contained in:
44
docs/authors.md
Normal file
44
docs/authors.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# Autoria e Contribuições
|
||||
|
||||
## Colaboradores
|
||||
|
||||
| Tag | Nome | Papel inicial |
|
||||
| --- | --- | --- |
|
||||
| `VTO` | Vitor Cesa | Organização do repositório, estrutura inicial, pré-processamento e documentação |
|
||||
| `GNR` | Generoso | Colaborador |
|
||||
| `JOM` | João Marcos | Colaborador e origem inicial do relatório de inspeções |
|
||||
|
||||
## Instituição e contexto
|
||||
|
||||
Projeto desenvolvido para apoiar o OARMP do Esquadrão Arara, em Manaus, com organização colaborativa em repositório Git.
|
||||
|
||||
## Como contribuir
|
||||
|
||||
Ao modificar ou estender este projeto:
|
||||
|
||||
1. Atualize sua cópia com `git pull` antes de começar.
|
||||
2. Preserve documentos originais em `raw/`.
|
||||
3. Coloque scripts e saídas intermediárias em `pre_process/`.
|
||||
4. Coloque resultados finais e validados em `processed/`.
|
||||
5. Registre mudanças operacionais em `LOG.md`.
|
||||
6. Registre mudanças de versão em `docs/changelog.md` quando houver alteração significativa.
|
||||
7. Identifique o autor usando a tag do colaborador: `VTO`, `GNR` ou `JOM`.
|
||||
8. Use mensagens de commit curtas e objetivas.
|
||||
|
||||
## Formato sugerido para mudanças de versão
|
||||
|
||||
```text
|
||||
## v<versão> — <Autor ou tag> — <YYYY-MM>
|
||||
|
||||
### Adicionado / Alterado / Corrigido / Removido
|
||||
|
||||
- Descrição objetiva da mudança.
|
||||
```
|
||||
|
||||
## Histórico de contribuições
|
||||
|
||||
| Versão | Autor | Data | Descrição resumida |
|
||||
| --- | --- | --- | --- |
|
||||
| v0.1 | VTO | 2026-06 | Estrutura inicial, documentação, pré-processamento do primeiro relatório de inspeções e migração para o repositório `arara_oarmp` |
|
||||
|
||||
Contribuidores futuros devem adicionar uma linha nesta tabela e criar a entrada correspondente em `docs/changelog.md`.
|
||||
Reference in New Issue
Block a user