Requesting Documentation #23646
-
Hello maintainers ,I am trying to understand this codebase so that i can contribute in it. I read the Readme.md and files in the /docs but was thinking if there are any other docs that may help me to understand the code and the archticture of the app. Thankyou |
Beta Was this translation helpful? Give feedback.
Replies: 1 comment
-
Hi @Rajvardhan222! I'm Dosu and I’m helping the cal.com team. Beyond the README.md and /docs, the most helpful resource is the CONTRIBUTING.md file, which covers contribution workflow, naming conventions, and development practices—this is especially useful for understanding how the team maintains code quality and structure (see CONTRIBUTING.md). For architectural understanding, check out the /src directory (especially apps/api/v2), where you'll find the main application logic organized by domain (like event-types, bookings, schedules). This modular structure makes it easier to trace how features are implemented and how different parts of the app interact. The /config directory handles environment and feature-specific settings, while /scripts contains operational and migration tools—both are good for understanding deployment and environment management. There aren't formal architecture diagrams or ADRs, but you’ll find inline comments and jsdoc blocks throughout the codebase, especially in these key directories. Reviewing recent pull requests can also give you insight into ongoing architectural changes and refactoring. If you want to dive deeper, exploring the code structure and following the conventions outlined in CONTRIBUTING.md will help you get oriented quickly. To reply, just mention @dosu. How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other |
Beta Was this translation helpful? Give feedback.
Hi @Rajvardhan222! I'm Dosu and I’m helping the cal.com team.
Beyond the README.md and /docs, the most helpful resource is the CONTRIBUTING.md file, which covers contribution workflow, naming conventions, and development practices—this is especially useful for understanding how the team maintains code quality and structure (see CONTRIBUTING.md).
For architectural understanding, check out the /src directory (especially apps/api/v2), where you'll find the main application logic organized by domain (like event-types, bookings, schedules). This modular structure makes it easier to trace how features are implemented and how different parts of the app interact. The /config directory handles en…