Guides
Contribute
Choose a contribution, prepare evidence and find the guide for your task.
Where to start
Start new features in GitHub Discussions. Report bugs in an issue with the command, actual output and version. Documentation and small fixes can go straight to a PR. Check existing issues and the roadmap first; comment on an issue before picking it up.
Prepare a verifiable change
A PR explains the problem, change, evidence, baseline and risk. Include actual command output. Separate regressions from existing failures; behavior changes need a test that reproduces the problem. Using ork is recommended and optional. The maintainer integrates with passing CI at the exact commit and handles publishing.
Integration tests require ORKMIND_TEST_DATABASE_URL and erase the test database. Use only a dedicated test database; read CONTRIBUTING before running the full suite.
pip install -e ".[dev]"
pytest -m "not integration"One guide per task
OrkMind does not yet have its own contribution guide series. Use the Orkastery guides for the contribution workflow and OrkMind’s CONTRIBUTING for its specific commands and contracts.
Source guides are currently in Brazilian Portuguese. English versions are planned before launch. Clear contributions in English are welcome.
Response time, review and security
The target is an initial response to issues within 7 days, and an initial PR review within the same period. This is a target, not a guarantee. If it is missed, comment on the original request. Report vulnerabilities through the private channel in SECURITY.md. Keep secrets, personal information and customer data out of the repository.