Contributing to Direx
Thanks for wanting to help. Direx has one maintainer with a few hours a week, so these rules keep reviews possible. The founder makes the final call on what gets merged.
Pull requests from outside can’t be merged yet. The Contributor License Agreement is still a draft, and nothing is merged without it. Until it is in force, issues and security reports are welcome, and a pull request will wait.
Before you write code
Section titled “Before you write code”- Work on an
acceptedissue. Only issues with theacceptedlabel are open for outside PRs. Comment on the issue to claim it, so two people don’t build the same thing. A PR without an accepted issue is closed, however good it is. - Want something else? Open an issue and describe it. If the maintainer labels it
accepted, it’s yours. - Read AGENTS.md for the commands and layout, and
CONSTRAINTS.md for the quality bar. Don’t weaken
CONSTRAINTS.mdto make a change pass.
Your pull request
Section titled “Your pull request”- Keep it under 500 changed lines and 10 files. Split bigger work into several PRs.
- Run
bun run check:taskand make sure it passes before you open the PR. - Fill in the PR template, including the link to the accepted issue.
- The maintainer replies within 14 days. If you hear nothing by then, comment on the PR.
Changes to approvals, the action ledger, tenancy, credentials, migrations, CONSTRAINTS.md and
the checks in scripts/ always need the maintainer’s review. Those PRs take longer.
AI-written code
Section titled “AI-written code”AI-written code is welcome, and you don’t have to say you used it. You do have to understand it: the maintainer may ask you to explain any line, and “the model wrote it” isn’t an answer.
Where code comes from
Section titled “Where code comes from”- Channel and provider code is written from the platform’s own API documentation. Link the docs you used in the PR. Never copy code from Postiz or any other AGPL project.
- No third-party AGPL or GPL code or dependencies. The CLA can’t relicense code we don’t hold
the rights to.
bun run check:licenserefuses an installed dependency whose license isn’t on its list, so a new license is read by a person first. - Third-party code under other licenses keeps its original header and license notice.
License and CLA
Section titled “License and CLA”The core is AGPL-3.0-only, and packages/plugin-sdk and skills/ are MIT. Every TypeScript and
JavaScript source file starts with an SPDX header; bun run check:license checks it. Everything
without a header, such as migrations, docs and prompts, is under the root LICENSE.
Before your first PR is merged, you sign the Contributor License Agreement. Once the agreement is in force, a bot will ask you on the PR, and signing takes one click. The CLA lets KD Partners LTD, the company behind Direx, license your contribution on any terms, including the paid cloud. We use a CLA, not a DCO sign-off.
Security problems
Section titled “Security problems”Don’t open a public issue. See SECURITY.md.
Conduct
Section titled “Conduct”Everyone here follows the code of conduct.
From CONTRIBUTING.md at v0.1.0. To fix this page, change that file in trydirex/direx; the site picks it up with the next release.