Benny JooandDevin AI
ab21c7f805
* feat: Cal.diy — community-driven MIT-licensed fork of Cal.com This squashed commit contains all Cal.diy changes applied on top of calcom/cal.com main: - Rebrand Cal.com to Cal.diy across the entire codebase - Remove Enterprise Edition (EE) features, license checks, and AGPL restrictions - Switch license from AGPL-3.0 to MIT - Remove docs/ directory (migrated to Nextra at cal.diy) - Remove dead code: org tests, EE tips, platform nav, premium username, SAML/SSO, etc. - Clean up .env.example for self-hosted Cal.diy - Update Docker image references to calcom/cal.diy - Update README, CONTRIBUTING.md, and issue templates for Cal.diy community fork - Add PR welcome bot for Cal.diy contributors - Fix API v2 breaking changes oasdiff ignore entries - Replace Blacksmith CI runners with default GitHub Actions 3893 files changed, 20789 insertions(+), 411020 deletions(-) Co-Authored-By: benny@cal.com <sldisek783@gmail.com> * refactor: remove org-specific /organizations/:orgId endpoints from API v2 atoms controllers (#1701) Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> * fix: revert Cal.diy Inc to Cal.com, Inc. in license files, copyright notices, and package metadata (#1702) Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> * rip out org related comments in api v2 --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
26 lines
1.6 KiB
Markdown
26 lines
1.6 KiB
Markdown
## App Contribution Guidelines
|
|
|
|
#### `DESCRIPTION.md`
|
|
|
|
1. images - include atleast 4 images (do we have a recommended size here?). Can show app in use and/or installation steps
|
|
2. add only file name for images, path not required. i.e. `1.jpeg`, not `/app-store/zohocalendar/1.jpeg`
|
|
3. description should include what the integration with Cal allows the user to do e.g. `Allows you to sync Cal bookings with your Zoho Calendar`
|
|
|
|
#### `README.md`
|
|
|
|
1. Include installation instructions and links to the app's website.
|
|
|
|
2. For url use `<baseUrl>/api/integrations`, rather than `<Cal.diy>/api/integrations`
|
|
|
|
#### `config.json`
|
|
|
|
1. set `"logo": "icon.svg"` and save icon in `/static`. Don't use paths here.
|
|
2. description here should not exceed 10 words (this is arbitrary, but should not be long otherwise it's truncated in the app store)
|
|
|
|
#### Others
|
|
|
|
1. Add API documentation links in comments for files `api`, `lib` and `types`
|
|
2. Use [`AppDeclarativeHandler`](../types/AppHandler.d.ts) across all apps. Whatever isn't supported in it, support that.
|
|
3. README should be added in the respective app and can be linked in main README [like this](https://github.com/calcom/cal.diy/pull/10429/files/155ac84537d12026f595551fe3542e810b029714#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R509)
|
|
4. Also, no env variables should be added by an app. They should be [added in `zod.ts`](https://github.com/calcom/cal.diy/blob/main/packages/app-store/jitsivideo/zod.ts) and then they would be automatically available to be modified by the cal.com app admin. In local development you can open /settings/admin with the admin credentials (see [seed.ts](packages/prisma/seed.ts))
|