Skip to content
Orkastery

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.

Run commands from the checkout root. The testing guide lists the complete checks.

With ork, ci prepare writes .ork-ci/<thread>.json for your thread only; make it the PR’s last commit, and the ork-verify check finds it by branch name.

Changed skills, references, the Claude Code or Codex adapters, or the version in core/package.json? Run node core/scripts/gerar-marketplaces.cjs and commit the result; CI checks it with --verificar. Changed an item’s frontmatter? Regenerate only its tables with docs sincronizar --escrever --so RM-NNN.

npm --prefix core ci
npm --prefix core run build
npm --prefix core run test:ci
node core/dist/index.js eval

One guide per task

Source guides are in Brazilian Portuguese, like the rest of the docs folder. Clear technical contributions in English are welcome and are never turned away for language alone.

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.