-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #48 from mhadaily/patch-1
Fix tips.mdx syntax error
- Loading branch information
Showing
1 changed file
with
5 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,8 +2,8 @@ | |
|
||
We require a few conventions to standardize things and to avoid conflicts. These are as follows: | ||
|
||
1. Plugin Name: Let's consider a plugin which provides authentication, named as Auth. | ||
2. Class Name: The name of the class will be your plugin name suffixed with 'Plugin' i.e. AuthPlugin. | ||
3. getPluginName: When returning the name of the plugin, we add <plugin_name> with @, followed by the version. ex : [email protected] (<plugin_name>@). | ||
4. Adding functions: While functions can be added to pluginStore with any name, to ensure uniqueness across plugins, we recommend the format <plugin_name>.<function_name>. Ex : Auth.authenticate. | ||
5. Events: Events can be added and dispatched from pluginStore using any name. To show which event belongs to which plugin, we recommend the format <plugin_name>.<event_name> Ex: Auth.checking. | ||
1. Plugin Name: Let's consider a plugin named Auth that provides authentication. | ||
2. Class Name: The name of the class will be your plugin name suffixed with 'Plugin', i.e., AuthPlugin. | ||
3. getPluginName: When returning the name of the plugin, we add `<plugin_name>` with @, followed by the version. ex: [email protected] (`<plugin_name>@`). | ||
4. Adding functions: While functions can be added to pluginStore with any name, we recommend the format `<plugin_name>.<function_name>` to ensure uniqueness across plugins. Ex: Auth.authenticate. | ||
5. Events: Events can be added and dispatched from pluginStore using any name. To show which event belongs to which plugin, we recommend the format `<plugin_name>.<event_name>` Ex: Auth.checking. |