Contributing
AccessAgent is open source under the MIT License and welcomes contributions of all kinds.
Ways to contribute
Section titled “Ways to contribute”- Bug reports — open an issue on GitHub describing what happened and what you expected
- Feature requests — open an issue with your idea and the problem it solves
- Documentation — improve or extend the docs site (this site is in the
web/repo) - Code — fix bugs or implement features from the issue tracker
Development setup
Section titled “Development setup”-
Fork and clone
Terminal window git clone https://github.com/your-username/accessagent-corecd accessagent-core -
Install dependencies
Terminal window bun install -
Set up environment
Terminal window cp .env.example .env# Edit .env with your DATABASE_URL and OPENAI_API_KEY -
Run database migrations
Terminal window bun run db:migrate -
Start the development server
Terminal window bun run devThe app runs at http://localhost:3000 with hot reload.
Code standards
Section titled “Code standards”- TypeScript everywhere — no
.jsfiles - No comments unless the WHY is non-obvious — good names are documentation
- No Python — all scripts and tooling use TypeScript/Bun
- Adapter pattern — auth, storage, and any new external dependencies must go through their interface
Pull requests
Section titled “Pull requests”- One PR per feature or bug fix
- Write a clear description of what the PR does and why
- If your PR fixes an issue, reference it: “Fixes #123”
- Keep PRs small — easier to review, more likely to merge
Reporting security issues
Section titled “Reporting security issues”For security vulnerabilities, do not open a public GitHub issue. Email steban@gmail.com with details. We’ll respond within 48 hours.