Compare commits
2 Commits
a6e5685d82
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
10ed0fcd2c | ||
|
|
58903c102e |
217
README-docs.md
217
README-docs.md
@@ -1,217 +0,0 @@
|
|||||||
# 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/`**.
|
|
||||||
3
README.md
Normal file
3
README.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
# Neochan
|
||||||
|
Where Neocities engages.<br>
|
||||||
|
status: [active](https://github.com/synt-xerror/synt-xerror)
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# 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.
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
syntax
|
|
||||||
markz
|
|
||||||
esmera
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
## 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)
|
|
||||||
@@ -1,9 +0,0 @@
|
|||||||
## Nova branch docs
|
|
||||||
Decidido:
|
|
||||||
- Nova branch exclusiva para documentação e comunicação (docs)
|
|
||||||
|
|
||||||
Motivo:
|
|
||||||
- Organização do repositório
|
|
||||||
|
|
||||||
-- Rafael (2025-12-31)
|
|
||||||
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
# 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)
|
|
||||||
Reference in New Issue
Block a user