Contributing
How to propose a change to Appstrate.
Thanks for your interest in contributing. This page is the short version. The canonical reference is the CONTRIBUTING.md at the root of the repo. When the two drift, the repo wins.
For setup, commands, and infrastructure tiers, see Get Started. This page is only about the contribution workflow.
Getting help
- Discord: quick questions, real-time chat.
- GitHub Discussions: long-form questions, proposals, show-and-tell.
- GitHub Issues: bug reports and feature requests, via the provided templates.
All participants are expected to follow the Code of Conduct.
Ways to contribute
Code is one path among several. Doc fixes, translations (French / English via apps/web/src/locales/), triage, design feedback, and community support are all first-class contributions. Start from the bug report or feature request templates.
Branch naming
feat/short-description: new featuresfix/short-description: bug fixesdocs/short-description: documentationrefactor/short-description: refactoring
Commit messages
Follow Conventional Commits. Enforced by commitlint (@commitlint/config-conventional).
feat: add webhook retry configuration
fix: prevent duplicate cron runs
docs: update API overview table
refactor: extract credential validation into serviceCommit signing (GPG or SSH) is recommended, not yet mandatory.
Pull request process
- Create a branch from
mainusing the naming convention above. - Make focused, self-contained commits.
- Run
bun run checkandbun testlocally. Both must pass. - Open a PR against
mainwith a clear description. API changes must update the OpenAPI spec in the same PR. - Sign the CLA on your first contribution. The bot guides you through it.
- Wait for CI and review. Squash and merge after approval.
Review criteria
- Quality gate passes (
bun run check+bun test). - Changes match the PR description, no unrelated churn bundled in.
- New features include tests. API changes include OpenAPI updates.
Response times
Goals, not guarantees:
- Issue acknowledgment: within 5 business days
- Bug triage: within 10 business days
- First PR review: within 10 business days
- Security reports: within 48 hours (see SECURITY.md)
License
By contributing, you agree that your contributions will be licensed under Apache License 2.0.