Contribuir
As regras que mantêm o motor, o editor Rust e a documentação consistentes, mais os comandos exatos que um pull request tem de passar.
Regras base#
- C++20, CMake 3.20+ e SDL3 no motor; Rust 2021 + Iced 0.14 no Doppio. Siga o estilo do ficheiro que edita.
- Diffs mínimos — uma preocupação por alteração; sem refactors oportunistas.
- Testes primeiro — adicione ou atualize um teste quando o comportamento muda.
- Sem código de frontend no core —
caffeine-corenão tem ImGui, painéis nem estado do editor. Os frontends comunicam porlibcaffeine-capi. - Sem código de plugins no motor — os plugins vivem em
doppio-plugins. - A documentação é HTML-first — veja
DOCS_STYLE.md.
Fluxo de trabalho#
./scripts/submodules.sh
./scripts/build.sh release
cd doppio && cargo build -p doppio-ui
Antes de abrir um pull request:
cd build && ctest --output-on-failure
cd ../doppio && cargo test
cd .. && ./scripts/check-rust-ui.sh
git diff --check
cmake --build build --target audit-plugin-coupling
check-rust-ui.sh inclui formatação, testes, clippy, a auditoria de acoplamento
core/ImGui e os flows de UI headless. Um novo comportamento visível ao utilizador
também precisa de um flow em doppio/tests/ui-flows/.
Alterações ao editor#
- Adicione um
UiIde uma entrada emCATALOGpara cada widget interativo (doppio/crates/ui/src/uikit/id.rs). - As mutações passam por
MessageeApp::update; os painéis apenas compõem componentes. - Registe um passo de undo com
App::commitem cada comando de edição. - Mantenha o viewport não bloqueante: render offscreen e polling do readback.
- Exponha comandos para agentes como ações que devolvem
Messageemmain/agent.rs.
Plugins#
Adicione ou altere plugins no repositório
doppio-plugins. O motor é dono
do SDK público (include/caffeine/plugin/) e do host; o editor C++ arquivado é apenas
referência. Veja Escrever um plugin.
Documentação#
- O inglês vive em
caffeine-website/content/en/docs/; o português espelha os mesmos caminhos emcontent/pt/docs/. - Cada página começa com título, uma faixa
doc-metae um lede curto. - As capturas vêm do driver headless, nunca de um screenshot do desktop.
- Atualize o flow de captura em
doppio/docs/flows/quando a UI mudar. - Corra as duas auditorias:
cd caffeine-website
python3 scripts/audit-docs.py --include-engine
python3 scripts/audit-docs-i18n.py
Estilo de commits#
Use um assunto imperativo curto e explique o porquê no corpo. Não faça commit de artefactos de build, configuração local ou caches geradas. Uma alteração de documentação deve atualizar a página inglesa, o espelho português e as imagens no mesmo commit.