From 934931f37d2192ed01593254bcea935a763eefd8 Mon Sep 17 00:00:00 2001 From: Jakub Chrzanowski Date: Wed, 8 Sep 2021 11:51:49 +0200 Subject: [PATCH] sdk_code_guidelines.md: add note about README for code samples (#548) --- SAMPLE_README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 SAMPLE_README.md diff --git a/SAMPLE_README.md b/SAMPLE_README.md new file mode 100644 index 000000000..08df42348 --- /dev/null +++ b/SAMPLE_README.md @@ -0,0 +1,40 @@ +# Sample [![JetBrains IntelliJ Platform SDK Docs](https://jb.gg/badges/docs.svg)][docs] +*Reference: [Sample Article in IntelliJ SDK Docs][docs:sampleArticle]* + +## Quickstart + +The Sample implements `com.intellij.sample` Extension Point, which should be explained properly in this Quickstart section. + +### Extension Points + +| Name | Implementation | Extension Point Class | +| --------------------- | ------------------------------------------------- | --------------------- | +| `com.intellij.sample` | [SampleExtensionPoint][file:SampleExtensionPoint] | `ExtensionPoint` | + +*Reference: [Plugin Extension Points in IntelliJ SDK Docs][docs:ep]* + +### Actions + +| ID | Implementation | Base Action Class | +| -------------------------------------- | --------------------------------- | ----------------- | +| `org.intellij.sdk.action.SampleAction` | [SampleAction][file:SampleAction] | `AnAction` | + +*Reference: [Action System in IntelliJ SDK Docs][docs:actions]* + +### Listeners + +| Name | Implementation | Listener Class | +| -------- | ------------------------------------- | -------------- | +| listener | [SampleListener][file:SampleListener] | `Listener` | + +*Reference: [Plugin Listeners in IntelliJ SDK Docs][docs:listeners]* + +[docs]: https://plugins.jetbrains.com/docs/intellij/ +[docs:actions]: https://plugins.jetbrains.com/docs/intellij/basic-action-system.html +[docs:ep]: https://plugins.jetbrains.com/docs/intellij/plugin-extensions.html +[docs:listeners]: https://plugins.jetbrains.com/docs/intellij/plugin-listeners.html +[docs:sampleArticle]: https://plugins.jetbrains.com/docs/intellij/sampleArticle.html + +[file:SampleExtensionPoint]: ./src/main/java/org/intellij/sdk/sample/SampleExtensionPoint.java +[file:SampleAction]: ./src/main/java/org/intellij/sdk/sample/SampleAction.java +[file:SampleListener]: ./src/main/java/org/intellij/sdk/sample/SampleListener.java