Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 1.05 KB

File metadata and controls

31 lines (23 loc) · 1.05 KB

Contributing Guide

Add a New Library

  1. Download assets from the official release, npm package, or a trusted package CDN.
  2. Store files under /cdn/{slug}/{version}/.
  3. Add a complete entry to _data/cdns.yml.
  4. Add the version to _data/versions.yml.
  5. Run ruby scripts/validate-local-cdn.rb.
  6. Run jekyll build.

Data Rules

  • Use lowercase stable slugs.
  • Use an existing category slug from _data/categories.yml.
  • Use status active, deprecated, or experimental.
  • Use type css, js, font, utility, ui, or analytics.
  • Include license information for every entry.
  • Include a fallback note for every entry.
  • Keep snippets local to https://cdn.itisuniqueofficial.com/.

Version Rules

Never overwrite an existing version folder. If a library is updated, create a new version folder and keep the previous version intact for backward compatibility.

UI Rules

  • Keep design plain and no-shadow.
  • Use semantic HTML and accessible labels.
  • Avoid adding unnecessary JavaScript.
  • Do not auto-load listed CDN libraries on the site.