maronato/cal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
cal/packages/app-store/CONTRIBUTING.md
Aldrin 3e08c66888
refactor: Use template literal instead of '+' operator (#11444) 
Co-authored-by: Peer Richelsen <peeroke@gmail.com>
Co-authored-by: zomars <zomars@me.com>
2023-10-03 11:52:19 -07:00

1.6 KiB
Raw Permalink Blame History

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.com>/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 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
  4. Also, no env variables should be added by an app. They should be added in 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)