mirror of
https://github.com/JetBrains/intellij-sdk-code-samples.git
synced 2025-07-28 09:17:50 +08:00
26 lines
1.5 KiB
Markdown
26 lines
1.5 KiB
Markdown
[//]: # (title: Contributing to the IntelliJ Platform SDK)
|
|
|
|
<!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
|
|
|
|
This document describes our contribution guidelines for the open-source IntelliJ Platform SDK documentation and sample code.
|
|
Before you begin contributing content to the SDK, please read this page thoroughly as well as the [Code of Conduct](intellij-sdk-docs-original_CODE_OF_CONDUCT.md) and [License](https://github.com/JetBrains/intellij-sdk-docs/blob/main/LICENSE.txt) documents.
|
|
For information about contributing to the IntelliJ Platform itself, please visit [Contributing to the IntelliJ Platform](platform_contributions.md).
|
|
|
|
## Creating IntelliJ Platform SDK Content
|
|
|
|
Content contributions to the IntelliJ Platform SDK are welcome.
|
|
|
|
Please download or clone the open-source SDK project from [GitHub](https://github.com/JetBrains/intellij-sdk-docs), make additions or changes, and submit a pull request.
|
|
|
|
Before creating or altering content, please consult these guides:
|
|
|
|
* [SDK Documentation Style Guide](sdk_style.md).
|
|
This guide describes documentation conventions in terms of Markdown syntax.
|
|
* [SDK Code Sample Guidelines](sdk_code_guidelines.md).
|
|
Conventions for code sample organization, project settings, and naming conventions are described in this document.
|
|
Always test code changes by building and testing the SDK code sample.
|
|
|
|
> Currently, building the site locally is not possible.
|
|
>
|
|
{type="note"}
|