Naming conventions

GitHub Repositories

• Repository name:
  • kontent-<project-name> for Kentico Kontent projects under the Kentico GitHub organization
  • kentico-kontent-<project-name> for any externally maintained Kentico Kontent projects
  • ems-<project-name> for Kentico EMS projects under the Kentico GitHub organization
  • kentic-ems-<project-name> for any externally maintained Kentico EMS projects
• <project-name> guidelines:
  • Use a broad-to-specific convention to keep similar projects grouped together
    • e.g. kontent-delivery-sdk-js + kontent-delivery-sdk-net
  • If a particular project is a plugin/module/etc. for an existing technology with specific naming conventions, use those
    • e.g. gatsby-source-kontent or gridsome-source-kontent
• Tagging
  • Tag with the kentico-kontent or kentico-ems
  • Use any other appropriate tags for the repo. (e.g. gatsby, gatsbyjs, source-plugin, etc.)

Code

• Namespaces:
  • Kentico.Kontent.* for Kentico Kontent projects under the Kentico GitHub organization
  • <YourCompany>.Kentico.Kontent.* for any externally maintained Kentico Kontent projects
  • Kentico.Ems.* for Kentico EMS projects under the Kentico GitHub organization
  • <YourCompany>.Kentico.Ems.* for any externally maintained Kentico EMS projects

Packages

• The name of the package should reflect the repo name
• When it makes sense use organization prefixes
  • e.g. @kentico/kontent-deliver-sdk-js or @meeg/gridsome-source-kentico-kontent
• For projects under the Kentico GitHub organization ONLY:
  • Use appropriate icons from https://github.com/Kentico/Home/tree/master/images