hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 18:27:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

Added <depends> for compatibility with IntelliJ IDEA

Browse Source
This commit is contained in:
JohnHake 2019-05-31 11:35:40 -07:00
parent 299947cfee
commit 54e844935f
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
intro/sdk_code_guidelines.md
View File

@ -6,6 +6,9 @@ This document describes the coding guidelines used for authoring open source Int
Before you begin, please read this page thoroughly as well as the [Code of Conduct](/CODE_OF_CONDUCT.md) and [License](https://github.com/JetBrains/intellij-sdk-docs/blob/master/LICENSE.txt) documents.
For information about contributing to the IntelliJ Platform itself visit [Contributing to the IntelliJ Platform](/basics/platform_contributions.md).
* Dummy list item
{:toc}
## Objectives
Keep the following considerations in mind while authoring an SDK code sample:
* The purpose of an SDK sample is to demonstrate an implementation pattern to build on top of subsystems and components of the IntelliJ Platform.
@ -136,6 +139,8 @@ The sequence of elements in an SDK code sample `plugin.xml` file is:
Set the attributes:
* `email` omit this attribute.
* `url` to the JetBrains plugin repository `"https://plugins.jetbrains.com"`
* `<depends>` set the value to `com.intellij.modules.java` to indicate [compatibility](/basics/getting_started/plugin_compatibility.md) with IntelliJ IDEA.
Add other `<depends>` elements as needed to indicate compatibility with other IntelliJ Platform-based IDEs.
* The remainder of the [plugin configuration elements](/basics/plugin_structure/plugin_configuration_file.md) should only appear if they are needed by a specific plugin.
## Testing