Compare commits
6 Commits
433e76ccf2
...
docs
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a6e5685d82 | ||
|
|
2c630b66eb | ||
|
|
7dd1ff8c1b | ||
|
|
15424a982c | ||
|
|
ae47d38bb6 | ||
|
|
ec05222bfd |
217
README-docs.md
Normal file
217
README-docs.md
Normal file
@@ -0,0 +1,217 @@
|
||||
# Regras do repositório `docs/`
|
||||
|
||||
Este diretório contém a **comunicação técnica e organizacional** do projeto.
|
||||
Não é um chat, não é um fórum, não é lugar para código grande.
|
||||
|
||||
O objetivo é:
|
||||
|
||||
* manter histórico claro
|
||||
* registrar decisões importantes
|
||||
* reduzir ruído
|
||||
* permitir que qualquer pessoa entenda o projeto no futuro
|
||||
|
||||
---
|
||||
|
||||
## Idioma
|
||||
|
||||
A comunicação em `docs/` é feita em **português**.
|
||||
Este diretório é voltado para quem participa do projeto.
|
||||
|
||||
---
|
||||
|
||||
## Estrutura oficial
|
||||
|
||||
```text
|
||||
docs/
|
||||
├── README-docs.md # este arquivo
|
||||
├── assinaturas.txt # identificação das pessoas
|
||||
├── ideas.md # ideias abertas
|
||||
├── questions.md # dúvidas abertas
|
||||
├── todo.md # tarefas práticas
|
||||
├── architecture.md # visão geral do sistema
|
||||
└── decisions/ # decisões estruturais (ADR)
|
||||
```
|
||||
|
||||
Não criar novos arquivos sem consenso.
|
||||
|
||||
---
|
||||
|
||||
## Identificação das pessoas (obrigatório)
|
||||
|
||||
### Git
|
||||
|
||||
Cada pessoa deve usar **nome e email consistentes** no Git.
|
||||
O email pode ser específico do projeto.
|
||||
|
||||
```bash
|
||||
git config --global user.name "Nome Sobrenome"
|
||||
git config --global user.email "nome@projeto.org"
|
||||
```
|
||||
|
||||
### Assinatura nos documentos
|
||||
|
||||
Toda entrada relevante termina com assinatura simples:
|
||||
|
||||
```md
|
||||
— Nome (YYYY-MM-DD)
|
||||
```
|
||||
|
||||
* usar data ISO 8601
|
||||
* sem apelidos
|
||||
* sem emojis
|
||||
* sem conversa informal
|
||||
|
||||
---
|
||||
|
||||
## Regra global de edição
|
||||
|
||||
> **Conteúdo novo entra sempre no topo do arquivo**
|
||||
|
||||
Motivo:
|
||||
|
||||
* o que importa agora fica visível
|
||||
* histórico permanece preservado
|
||||
|
||||
---
|
||||
|
||||
## Papel de cada arquivo
|
||||
|
||||
### `ideas.md`
|
||||
|
||||
* ideias ainda não decididas
|
||||
* propostas iniciais
|
||||
* pensamento cru
|
||||
|
||||
Formato:
|
||||
|
||||
* uma ideia por seção
|
||||
* separador obrigatório `---`
|
||||
|
||||
---
|
||||
|
||||
### `questions.md`
|
||||
|
||||
* dúvidas reais
|
||||
* pontos em aberto
|
||||
|
||||
Quando resolvida:
|
||||
|
||||
* marcar como `(RESOLVIDO)`
|
||||
* **não apagar**
|
||||
|
||||
---
|
||||
|
||||
### `todo.md`
|
||||
|
||||
* tarefas objetivas
|
||||
* cada tarefa deve ter responsável
|
||||
|
||||
```md
|
||||
- [ ] Criar schema do banco (Pedro)
|
||||
```
|
||||
|
||||
Quando concluída, remover.
|
||||
|
||||
---
|
||||
|
||||
### `architecture.md`
|
||||
|
||||
* descreve o **estado atual** do sistema
|
||||
* visão geral dos componentes
|
||||
* não registra discussões
|
||||
* não explica decisões históricas
|
||||
|
||||
Mudanças estruturais devem ser refletidas aqui **após** uma decisão formal.
|
||||
|
||||
---
|
||||
|
||||
### `decisions/` (ADR)
|
||||
|
||||
Contém **decisões arquiteturais importantes**.
|
||||
|
||||
Cada arquivo representa **uma decisão fechada**.
|
||||
|
||||
Formato recomendado:
|
||||
|
||||
```text
|
||||
0001-titulo-curto.md
|
||||
```
|
||||
|
||||
Regras:
|
||||
|
||||
* decisão clara
|
||||
* contexto mínimo
|
||||
* consequências explícitas
|
||||
* não editar depois de aceita
|
||||
|
||||
Se algo mudar no futuro:
|
||||
|
||||
* criar um novo ADR
|
||||
|
||||
---
|
||||
|
||||
## Fluxo oficial de informação
|
||||
|
||||
```text
|
||||
idea → dúvida → decisão (ADR) → arquitetura
|
||||
```
|
||||
|
||||
* ideias nascem em `ideas.md`
|
||||
* incertezas vão para `questions.md`
|
||||
* decisões estruturais viram ADR
|
||||
* `architecture.md` reflete o resultado
|
||||
|
||||
---
|
||||
|
||||
## Padrão de commit (obrigatório)
|
||||
|
||||
Formato:
|
||||
|
||||
```
|
||||
<área>: <ação curta>
|
||||
```
|
||||
|
||||
Exemplos válidos:
|
||||
|
||||
```
|
||||
docs: adicionar ADR sobre boards
|
||||
docs ideas: nova proposta de moderação
|
||||
docs architecture: atualizar fluxo de dados
|
||||
```
|
||||
|
||||
Exemplos inválidos:
|
||||
|
||||
```
|
||||
update
|
||||
testando
|
||||
conversa
|
||||
```
|
||||
|
||||
Evitar commits com múltiplos objetivos.
|
||||
|
||||
---
|
||||
|
||||
## O que é proibido
|
||||
|
||||
* desabafo
|
||||
* conversa de chat
|
||||
* opinião sem contexto
|
||||
* texto vago
|
||||
* código grande em `docs/`
|
||||
|
||||
---
|
||||
|
||||
## O que é esperado
|
||||
|
||||
* texto curto e direto
|
||||
* ideias bem descritas
|
||||
* dúvidas objetivas
|
||||
* decisões claras
|
||||
* histórico preservado
|
||||
|
||||
---
|
||||
|
||||
## Regra final
|
||||
|
||||
Se não ajuda alguém a entender o projeto no futuro,
|
||||
**não pertence ao `docs/`**.
|
||||
18
architecture.md
Normal file
18
architecture.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Arquitetura Neochan
|
||||
|
||||
Este documento descreve a arquitetura atual do projeto.
|
||||
Ele não registra decisões históricas e nem discussões, apenas o estado
|
||||
aceito do sistema.
|
||||
|
||||
Mudanças arquiteturais relevantes devem ser registradas como ADRs em
|
||||
`docs/decisions/`
|
||||
|
||||
---
|
||||
|
||||
## Visão geral
|
||||
|
||||
O Neochan se trata de um Imageboard simples, focado em simplicidade,
|
||||
anonimato e baixo acoplamento entre componentes.
|
||||
|
||||
A ideia nasceu como um projeto para colocar em prática conceitos de
|
||||
colaboração de software e versionamento.
|
||||
10
decisions/0001-communication-on-git.md
Normal file
10
decisions/0001-communication-on-git.md
Normal file
@@ -0,0 +1,10 @@
|
||||
## 2025-12-30
|
||||
Decidido:
|
||||
- Comunicação será feita no repositório git.
|
||||
- Para informações mais sigilosas o uso de uma lista de e-mails será adotado.
|
||||
- Para informações rápidas ou menos formais será feito o uso do Discord ou WhatsApp.
|
||||
|
||||
Motivo:
|
||||
- Seguro para manter um histórico durável por muito tempo.
|
||||
|
||||
-- Rafael (2025-12-30)
|
||||
9
decisions/0002-new-branch-docs.md
Normal file
9
decisions/0002-new-branch-docs.md
Normal file
@@ -0,0 +1,9 @@
|
||||
## Nova branch docs
|
||||
Decidido:
|
||||
- Nova branch exclusiva para documentação e comunicação (docs)
|
||||
|
||||
Motivo:
|
||||
- Organização do repositório
|
||||
|
||||
-- Rafael (2025-12-31)
|
||||
|
||||
10
decisions/0003-no-more-multiple-change-commits.md
Normal file
10
decisions/0003-no-more-multiple-change-commits.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Evite commits com multiplas mudanças
|
||||
|
||||
Decisão:
|
||||
- Acabar com commits com várias mudanças de uma só vez
|
||||
|
||||
Motivos:
|
||||
- É desorganizado
|
||||
- Dificulta voltar mudanças
|
||||
|
||||
-- Rafael (2026-01-07)
|
||||
0
questions.md
Normal file
0
questions.md
Normal file
Reference in New Issue
Block a user