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

platform_contributions.md: cleanup, mention patch_welcome tag

Browse Source
This commit is contained in:
Yann Cébron 2023-02-01 11:41:59 +01:00
parent becdb7f9ae
commit cb13c02526
1 changed files with 24 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
topics/basics/platform_contributions.md
View File

@ -1,16 +1,20 @@
[//]: # (title: Contributing to the IntelliJ Platform) # Contributing to the IntelliJ Platform
<!-- 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. --> <!-- Copyright 2000-2023 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. -->
<tldr>How to participate and contribute in IntelliJ Platform development.</tldr>
Please make sure to read the [Code of Conduct](intellij-sdk-docs-original_CODE_OF_CONDUCT.md). Please make sure to read the [Code of Conduct](intellij-sdk-docs-original_CODE_OF_CONDUCT.md).
## Participate in the Community ## Participate in the Community
### Participate in Newsgroups and Forums ### Participate in Newsgroups and Forums
There are several community [forums and newsgroups](https://intellij-support.jetbrains.com/hc/en-us/community/topics) you can join to discuss the IntelliJ Platform.
There are several community [forums and newsgroups](https://intellij-support.jetbrains.com/hc/en-us/community/topics) you can join to discuss the IntelliJ Platform and IDEs.
The forums are an excellent source for users and contributors interested in having technical discussions, answering questions, or resolving potential issues for newcomers. The forums are an excellent source for users and contributors interested in having technical discussions, answering questions, or resolving potential issues for newcomers.
### Link to IntelliJ Platform Homepage ### Link to IntelliJ Platform Homepage
The success of any open-source project depends on the number of people who use the product and contribute back to the project. The success of any open-source project depends on the number of people who use the product and contribute back to the project.
By linking to [https://www.jetbrains.com/opensource/idea](https://www.jetbrains.com/opensource/idea), you can increase the chances of a new user or contributor finding out about the project and joining the community. By linking to [https://www.jetbrains.com/opensource/idea](https://www.jetbrains.com/opensource/idea), you can increase the chances of a new user or contributor finding out about the project and joining the community.
@ -18,48 +22,60 @@ If you're as excited about IntelliJ IDEA Community Edition as we are, you can sh
Project logos and other assets are [also available](https://www.jetbrains.com/company/brand/logos/). Project logos and other assets are [also available](https://www.jetbrains.com/company/brand/logos/).
### Promote IntelliJ Platform and IntelliJ IDEA Community Edition ### Promote IntelliJ Platform and IntelliJ IDEA Community Edition
Help promote the platform and IDE by using your blog, Twitter, Facebook, or submitting an article to your favorite local magazine. Help promote the platform and IDE by using your blog, Twitter, Facebook, or submitting an article to your favorite local magazine.
If you are a member of a different open-source community, why not mention IntelliJ IDEA on their discussion forums or at conferences? If you love IntelliJ IDEA, don't hold back - speak up! The more developers use IntelliJ IDEA, the more bugs will be caught, the more plugins will be written, the more visible the project, and the more benefits the community will get! If you are a member of a different open-source community, why not mention IntelliJ IDEA on their discussion forums or at conferences?
If you love IntelliJ IDEA, don't hold back — speak up!
The more developers use IntelliJ IDEA, the more bugs will be caught, the more plugins will be written, the more visible the project, and the more benefits the community will get!
## Help Others Learn ## Help Others Learn
### Write Documents ### Write Documents
We're always looking for new articles about IntelliJ IDEA features as well as documentation for the IntelliJ Platform. We're always looking for new articles about IntelliJ IDEA features as well as documentation for the IntelliJ Platform.
You can write tutorials, how-tos, sample applications, or share your experience with the IntelliJ Platform. You can write tutorials, how-tos, sample applications, or share your experience with the IntelliJ Platform.
You can publish your documentation on a website or blog, or submit a [pull request](intellij-sdk-docs-original_CONTRIBUTING.md) to the SDK Docs. You can publish your documentation on a website or blog, or submit a [pull request](intellij-sdk-docs-original_CONTRIBUTING.md) to the SDK Docs.
### Produce Screencasts ### Produce Screencasts
Screencasts have recently become very popular as a way to show other developers how to use the tool effectively. Screencasts have recently become very popular as a way to show other developers how to use the tool effectively.
You can record a screencast about a particular feature or use case you discovered and would like to share it with the community. You can record a screencast about a particular feature or use case you discovered and would like to share it with the community.
## Contribute Code ## Contribute Code
### File a Bug Report ### File a Bug Report
Bug reports take little time to file and are very helpful to developers. Bug reports take little time to file and are very helpful to developers.
This is one of the easiest contributions you can make. This is one of the easiest contributions you can make.
When you discover a problem with the IDE or the platform, please report it. When you discover a problem with the IDE or the platform, please report it.
Make sure you provide information about your environment (OS, JDK version), steps to reproduce the issue, as well as a written description of the problem. Make sure you provide information about your environment (available from <ui-path>About</ui-path> menu), steps to reproduce the issue, as well as a written description of the problem.
You can file a bug in our [YouTrack issue tracker](https://youtrack.jetbrains.com/issues/IDEA). You can file a bug in our [YouTrack issue tracker](https://youtrack.jetbrains.com/issues/IDEA).
Before submitting an issue, please search for already submitted ones describing the same problem - and if you find one, feel free to vote for it. Before submitting an issue, please search for already submitted ones describing the same problem — and if you find one, feel free to vote for it.
### Help Triage Existing Bug Reports ### Help Triage Existing Bug Reports
Over the years, users have submitted thousands of issues to the IntelliJ issue tracker.
Over the years, users have submitted thousands of issues to the IntelliJ IDEA issue tracker.
Many of the unresolved issues are no longer applicable to the latest version of IntelliJ IDEA, are duplicates, or require additional information to be resolved. Many of the unresolved issues are no longer applicable to the latest version of IntelliJ IDEA, are duplicates, or require additional information to be resolved.
Leaving comments notifying about the status of such issues helps the team keep the issue tracker clean and useful for everyone. Leaving comments notifying about the status of such issues helps the team keep the issue tracker clean and useful for everyone.
### Write a Plugin ### Write a Plugin
One of the best ways to contribute a larger piece of code, adding extra functionality to IntelliJ IDEA or any of the other IntelliJ Platform-based IDEs, is by writing a plugin. One of the best ways to contribute a larger piece of code, adding extra functionality to IntelliJ IDEA or any of the other IntelliJ Platform-based IDEs, is by writing a plugin.
You can submit a plugin to the [JetBrains Marketplace](https://plugins.jetbrains.com/), making it available for all users. You can submit a plugin to the [JetBrains Marketplace](https://plugins.jetbrains.com/), making it available for all users.
When writing a plugin, you have control over the code and don't need to sign the contribution agreement. When writing a plugin, you have control over the code and don't need to sign the contribution agreement.
### Submit a Patch ### Submit a Patch
If you would like to improve the code in the IntelliJ Platform or the core functionality of IntelliJ IDEA, you can submit a pull request to the [IntelliJ IDEA Community Edition repository on GitHub](https://github.com/JetBrains/intellij-community). If you would like to improve the code in the IntelliJ Platform or the core functionality of IntelliJ IDEA, you can submit a pull request to the [IntelliJ IDEA Community Edition repository on GitHub](https://github.com/JetBrains/intellij-community).
When preparing the change, please make sure to follow the [IntelliJ Platform Coding Guidelines](intellij_coding_guidelines.md). When preparing the change, please make sure to follow the [](intellij_coding_guidelines.md).
A developer will review your contribution and, if it meets the quality criteria and fits well with the rest of the code, you'll be notified about the acceptance of the patch. A developer will review your contribution and, if it meets the quality criteria and fits well with the rest of the code, you'll be notified about the acceptance of the patch.
Looking for issues to work on? Issues marked with [#patch_welcome](https://youtrack.jetbrains.com/issues/IDEA?q=%23patch_welcome%20%23unresolved) tag are looking for external contributors.
Alternatively, you can attach a patch to the ticket in the [YouTrack bug database](https://youtrack.jetbrains.com/issues/IDEA). Alternatively, you can attach a patch to the ticket in the [YouTrack bug database](https://youtrack.jetbrains.com/issues/IDEA).
You can either file a new issue with the patch attached or attach a patch to an issue submitted by another user. You can either file a new issue with the patch attached or attach a patch to an issue submitted by another user.
In this case, you will also need to sign the [JetBrains Contributor License Agreement (CLA)](https://www.jetbrains.com/agreements/cla/) to complete your contribution. In this case, you will also need to sign the [JetBrains Contributor License Agreement (CLA)](https://www.jetbrains.com/agreements/cla/) to complete your contribution.
### Become a Committer ### Become a Committer
Developers with a long history of submitting high-quality patches can gain direct commit rights. Developers with a long history of submitting high-quality patches can gain direct commit rights.