Skip to content

Naming conventions

Jump to bottom
Ondrej Polesny edited this page Jul 29, 2020 · 7 revisions

GitHub Repositories

  • Repository name:
    • kontent-<project-name> for Kentico Kontent projects under the Kentico GitHub organization
      • If the repository has any requirements for name, at least provide kontent somewhere in the repository name (i.e. sourcebit-source-kontent)
    • kentico-kontent-<project-name> for any externally maintained Kentico Kontent projects outside the Kentico GitHub organization
    • xperience-<project-name> for Kentico Xperience projects under the Kentico GitHub organization
    • kentico-xperience-<project-name> for any externally maintained Kentico Xperience 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-xperience
    • Use any other appropriate tags for the repo. (e.g. gatsby, gatsbyjs, source-plugin, etc.)

Code

Namespaces

We stick to Microsoft's conventions <Company>.(<Product>|<Technology>)[.<Feature>][.<Subnamespace>]. Some examples:

  • Kentico.Kontent.* for Kentico Kontent projects under the Kentico GitHub organization
  • <YourCompany>.Kentico.Kontent.* for any externally maintained Kentico Kontent projects
  • Kentico.Xperience.* for Kentico Xperience projects under the Kentico GitHub organization
  • <YourCompany>.Kentico.Xperience.* for any externally maintained Kentico Xperience projects
  • Kentico.<Technology>* for non-product related code. Eg. Kentico.AspNetCore.Http if the code is related to Microsoft.AspNetCore.Http.

Packages

Clone this wiki locally