Pular para o conteúdo

Guias

Contribuir

Escolha uma contribuição, prepare a prova e encontre o guia da sua tarefa.

Por onde começar

Feature nova começa no GitHub Discussions. Defeito começa por uma issue com o comando, a saída real e a versão. Documentação e correções pequenas podem ir direto a um PR. Consulte issues e roadmap antes de começar; comente na issue que pretende assumir.

Prepare uma mudança verificável

O PR traz o problema, a mudança, a prova, a baseline e o risco, e diz na seção de uso de agente quando um agente escreveu parte do diff. Cole a saída real dos comandos. Rode na main atual o mesmo comando que falhou para separar regressão de dívida anterior; mudança de comportamento pede teste que falhava antes e passa agora. Usar o ork é recomendado e opcional. O mantenedor integra com os checks obrigatórios verdes no commit exato e conduz a publicação.

O CI roda a suíte sem banco, o pacote e o plugin do OpenClaw; não roda a integração, o ruff nem o mypy. A integração apaga o banco de teste e só aceita alvo com test, _ci ou sandbox no nome, em ORKMIND_TEST_DATABASE_URL e ORKMIND_PROVIDER_TEST_DATABASE_URL. Rode-a quando mexer no que grava no banco e diga no PR o que rodou.

python -m pip install -e ".[dev,memory-provider,documents,qdrant,encryption]"
python -m pytest -m "not integration" -q

Um guia por tarefa

O OrkMind tem um guia por tarefa em docs/contribuir, indexado no CONTRIBUTING: do clone aos testes, documentação, estilo, pull request, triagem e publicação. Cada guia abre com a resposta em uma frase, e um teste confere que os comandos, caminhos e links citados existem.

Os guias estão em português do Brasil hoje; a versão em inglês está prevista antes do lançamento. Contribuições claras em inglês são bem-vindas.

No Orkastery e com o ork

Para contribuir com o Orkastery, ou conduzir a sua contribuição com o ork, use os guias do Orkastery. A suíte inteira do núcleo roda sem as dependências opcionais: o teste que precisa delas sai como skip com o motivo, e ORK_TESTE_EXIGE_AMBIENTE=1 não pula nada. O CI pede uma linha no CHANGELOG quando o PR muda core, adapters ou marketplaces, e o bundle de prova de cada thread fica em .ork-ci/<thread>.json.

Prazo, revisão e segurança

A meta é uma primeira resposta em até 7 dias para issues e uma primeira revisão no mesmo prazo para PRs. É meta, não garantia. Se passar do prazo, comente no pedido original. Vulnerabilidades vão pelo canal privado indicado em SECURITY.md. Nunca inclua segredos, dados pessoais ou dados de clientes no repositório.