Naming conventions

GitHub Repositories

Repository name:

• projects under the Kontent.ai Github organization don't need any further mention of the product in their name
• If a Kontent.ai related repository is managed in an external organization, use pattern kontent-ai-<project-name> or at least provide kontent-ai somewhere in the repository name (i.e. sourcebit-source-kontent-ai)

<project-name> guidelines:

• Use a broad-to-specific convention to keep similar projects grouped together (e.g. delivery-sdk-js + delivery-sdk-net)

Tagging

If you want to, you can mark your repository by specific GitHub topics. This ensures, you get to the topic listing and your repository will be much more accessible.

Feel free to use multiple topics. Use any other appropriate tags for the repo. (e.g. cli, dotnet, plugin, etc.)

• kontent-ai - General topic used in all repositories related to Kontent.ai.
  • kontent-ai-integration - Repository helps to integrate with other services (see Integrations info for more).
  • kontent-ai-tool Repository helps with the tooling around Kontent.ai (SDKs, CLIs, Generators, Mini apps using API etc.).
  • kontent-ai-sample Repository is showcasing the usage of Kontent.ai.

Code

Namespaces

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

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

Packages

• Package names should omit mentions of the technology stack, assuming it can be derived from the package manager (for example @kontent-ai/delivery-sdk-js package hosted on npm should lose the -js suffix)
• When it makes sense, use organization prefixes (e.g. @kontent-ai/deliver-sdk-js)
• For projects under the Kontent.ai Github organization ONLY: Use appropriate icons from https://github.com/kontent-ai/.github/tree/main/logos