Skip to content

Commit

Permalink
Add a section on naming conventions for Start and Setup (elastic#51676)
Browse files Browse the repository at this point in the history
  • Loading branch information
stacey-gammon authored Dec 4, 2019
1 parent ffdd392 commit 4a9d77f
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/core/CONVENTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,3 +247,8 @@ export function registerMyPluginUsageCollector(usageCollection?: UsageCollection
usageCollection.registerCollector(myCollector);
}
```

### Naming conventions

Export start and setup contracts as `MyPluginStart` and `MyPluginSetup`.
This avoids naming clashes, if everyone exported them simply as `Start` and `Setup`.

0 comments on commit 4a9d77f

Please sign in to comment.