-
Notifications
You must be signed in to change notification settings - Fork 11
Guidelines for Kontent related tools
Welcome to the Kentico Kontent developers! These guidelines should help you meet all the requirements for creating successful tools around Kentico Kontent APIs aligned with Kentico's values. It should also give you a solid starting point for development using the framework of your choice.
First of all, you should visit the Kentico Kontent Docs which gives you overall knowledge about Kentico Kontent possibilities and existing tools. Then check out the values of Kentico GitHub organization.
Once you know what you want to achieve and you haven't found an existing tool for that, read through the naming conventions and pick the right name for your tool.
Before you publicly offer any tool, it is recommended to read through the Kontent Github checklist for publishing an OS project to be aware of all enhancements you could implement to make the project more credible and well-perceived by the community.
To be able to better measure the adoption of your project, the tool should include the X-KC-SOURCE header with each request sent to the Kentico API (Delivery, Management, and Assets). The value of the header should be formatted as follows: <Tool identification>;<Tool version>. For example, Acme.KenticoKontent.AwesomeTool;1.0.0 or, for Kontent Sourcebit source plugin, @kentico/sourcebit-source-kontent;0.1.42. The version itself is not required, you can use just Tool identification like kentico-kontent-nuxt-module. However, we strongly recommend including the version to be able to track adoption among multiple versions.
If you follow this recommendation, we can provide you with aggregated analytic data about your tool's usage later on.
If you have any additional questions or comments, you can contact us directly at devrel@kentico.com.