intellij-sdk-docs-original_CONTRIBUTING.md: edits

This commit is contained in:
Yann Cébron 2022-05-10 10:50:29 +02:00
parent 402b9541f6
commit c8e1bb2d36

View File

@ -4,21 +4,22 @@
This document describes our contribution guidelines for the open-source IntelliJ Platform SDK documentation and sample code. 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. 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). For information about contributing to the IntelliJ Platform itself, please visit [Contributing to the IntelliJ Platform](platform_contributions.md).
## Creating IntelliJ Platform SDK Content ## Creating IntelliJ Platform SDK Content
Content contributions to the IntelliJ Platform SDK are welcome. Content contributions to the IntelliJ Platform SDK are very 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. Please clone the _intellij-sdk-docs_ project from [GitHub](https://github.com/JetBrains/intellij-sdk-docs), make additions or changes, and submit a pull request.
Alternatively, start by clicking on the <control>Edit page</control> link on the top of each page.
Before creating or altering content, please consult these guides: Before creating or altering content, please consult these guides:
* [SDK Documentation Style Guide](sdk_style.md). * [SDK Documentation Style Guide](sdk_style.md).
This guide describes documentation conventions in terms of Markdown syntax. This guide describes documentation conventions in terms of content style and syntax.
* [SDK Code Sample Guidelines](sdk_code_guidelines.md). * [SDK Code Sample Guidelines](sdk_code_guidelines.md).
Conventions for code sample organization, project settings, and naming conventions are described in this document. 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. > Currently, building the site locally is not possible.
> >