Plugins: naming policy

All these rules are either MUST or SHOULD rules for inclusion in default store.

Name of plugins

• Plugin name MUST be in lowercase
• Words MUST be separated by -
• Words order MUST be valid in english
• The plugin name MUST NOT contain "plugin" (we already know it's a plugin) nor "custom" (all plugins are custom)

Name of components

• Components name MUST be in lowercase
• Words MUST be separated by -
• Words order MUST be valid in english
• All components of a plugin MUST have a consistent naming (avoid inverting words order, excluding some words, ...)

Datasets

• A dataset name MUST start by the plugin name (because DSS uses the component name as the fully qualified identifier)
• A dataset name MUST NOT include "dataset" or "custom"
• Ideally a dataset name SHOULD be a noun group representing what the dataset displays

Recipes

• A recipe name MUST start by the plugin name (because DSS uses the component name as the fully qualified identifier)
• A recipe name MUST NOT include "recipe" or "custom"
• A recipe name SHOULD be either a noun group when it's obvious, or a verbal group representing the action that the recipe performs (In plugin "my-geocoder", you could have a recipe "my-geocoder-compute-distance")

Plugin labels

• A plugin label MUST NOT contain "plugin" or "custom"
• A plugin label MUST be a valid english noun group or verbal group

Component labels

• A component's label MUST NOT contain "dataset", "plugin", "custom", "recipe", ...
• A component's label SHOULD be as short as possible (don't forget it will be displayed in menus) while still fully descriptive.
• A component's label SHOULD be "clean" (capitalization, spacing, ...)

Tags

• Don't use "single usage" tags. For example, if your plugin is the plugin for the Fpoezy API, don't use tag Fpoezy, since it's very likely that no other plugin will use this. Use generic tags like "API", "Open Data", "Productivity", "Machine Learning"

Author

This rule is only for plugins written by Dataiku.

Author name MUST be: "Dataiku (Firstname Lastname)"