Contributing
This docs section is the contributor-facing guide for the repository. The project started as an internal Charles replacement, but the repo is being shaped so outside contributors can still understand:- how to run the workspace
- where code belongs
- how to propose changes cleanly
- how releases are cut
- what review etiquette is expected
Recommended reading order
- Quickstart for local setup
- Environment for runtime variables
- Contributor Architecture for repo shape
- Development for day-to-day standards
- Contribution Workflow before opening a PR
- Contributor Skills for repo-local agent workflows
- Issue & PR Etiquette before asking for review
- Release Process if your work affects shipping
Current OSS posture
- The repo is public-facing in intent, but still product-heavy in terminology because it is replacing a live vendor dependency.
- The docs should explain current behavior, not only target architecture.
- Contributors should prefer small, reviewable changes over broad speculative refactors.
- Docs-only pull requests are welcome if they reduce ambiguity, tighten setup instructions, or clarify runtime contracts.
Good first contribution areas
- Mintlify navigation and page clarity
- API and webhook contract documentation
- environment/setup accuracy
- Storybook coverage for new UI primitives
- tests around compatibility and runtime behavior