This project and the corresponding community is governed by the [JetBrains Open Source and Community Code of Conduct](https://confluence.jetbrains.com/display/ALL/JetBrains+Open+Source+and+Community+Code+of+Conduct). Please make sure you read it.
[](https://github.com/JetBrains/.github/blob/main/profile/README.md) [](https://github.com/JetBrains/intellij-community/actions/workflows/IntelliJ_IDEA.yml?query=branch%3Amaster) [](https://github.com/JetBrains/intellij-community/actions/workflows/PyCharm.yml?query=branch%3Amaster)
# OpenIDE project
# IntelliJ Open Source Repository
The OpenIDE project is largely based on the OpenIDE Community Edition by JetBrains. You can learn more about the project at https://openide.ru.
This repository is the open-source part of the JetBrains IDEs codebase.
It also serves as the basis for[IntelliJ Platform development](https://www.jetbrains.com/opensource/idea).
These instructions will help you build and run open source parts of IntelliJ Platform / IntelliJ IDEA / PyCharm.
If you are new to the community and would like to contribute code or help others learn, see[CONTRIBUTING.md](https://github.com/JetBrains/intellij-community/blob/master/CONTRIBUTING.md)to get started.
These instructions will help you build and run open source parts of OpenIDE.
The following conventions will be used to refer to directories on your machine:
*`<USER_HOME>` is your OS user's home directory.
*`<IDEA_HOME>` is the root directory for the **IntelliJ source code**.
*`<IDEA_HOME>` is the root directory for the **OpenIDE source code**.
___
## Getting the Source Code
@@ -20,7 +18,7 @@ This section will guide you through getting the project sources and help avoid c
#### Prerequisites
- [Git](https://git-scm.com/) installed
- Install [IntelliJ IDEA 2023.2](https://www.jetbrains.com/idea/download) or higher.
- Install [OpenIDE 2024.3](https://openide.ru/download/other) or higher.
- For **Windows** set these git config to avoid common issues during cloning:
```
git config --global core.longpaths true
@@ -29,27 +27,22 @@ This section will guide you through getting the project sources and help avoid c
#### Clone Main Repository
IntelliJ open source repository is available from the [GitHub repository](https://github.com/JetBrains/intellij-community), which can be cloned or downloaded as a zip file (based on a branch) into `<IDEA_HOME>`.
The **master** (_default_) branch contains the source code which will be used to create the next major version of all JetBrains IDEs.
The branch names and build numbers for older releases of JetBrains IDEs can be found on the
[Build Number Ranges](https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html) page.
You can [clone this project](https://www.jetbrains.com/help/idea/manage-projects-hosted-on-github.html#clone-from-GitHub) directly using IntelliJ IDEA.
OpenIDE open source repository is available from the [Gitflic repository](https://gitflic.ru/project/openide/openide), which can be cloned or downloaded as a zip file (based on a branch) into `<IDEA_HOME>`.
Alternatively, follow the steps below in a terminal:
> - **For faster download**: If the complete repository history isn't needed, create [shallow clone](https://git-scm.com/docs/git-clone#Documentation/git-clone.txt---depthdepth)
> To download only the latest revision of the repository, add `--depth 1` option after `clone`.
> - Cloning in IntelliJ IDEA also supports creating shallow clone.
> - Cloning in OpenIDE also supports creating shallow clone.
#### Get Android Modules
IntelliJ IDEA requires additional Android modules from separate Git repositories.
OpenIDE requires additional Android modules from separate Git repositories.
Run the following script from project root `<IDEA_HOME>` to get the required modules:
- Linux/macOS: `./getPlugins.sh`
@@ -57,26 +50,18 @@ Run the following script from project root `<IDEA_HOME>` to get the required mod
> [!IMPORTANT]
>
> Always `git checkout` the `intellij-community` and `android` Git repositories to the same branches/tags.
> Always `git checkout` the `openide` and `android` Git repositories to the same branches/tags.
---
## Building IntelliJ IDEA
## Building OpenIDE
These instructions will help you build OpenIDE from source code, which is the basis for IntelliJ Platform development.
OpenIDE '**2024.3**' or newer is required.
These instructions will help you build IntelliJ IDEA from source code, which is the basis for IntelliJ Platform development.
IntelliJ IDEA '**2023.2**' or newer is required.
> [!IMPORTANT]
>
> IntelliJ IDEA project is currently being migrated to the [Bazel](https://bazel.build/) build system.
> The migration is still in progress, so you may encounter some rough edges or temporary issues along the way, mostly related to IDE integration.
> * Building the project using only IDE built-in capabilities is not supported anymore, so make sure the [Bazel plugin](https://plugins.jetbrains.com/plugin/22977-bazel) is installed and enabled.
> * Known issue: some tests are not yet possible to be run with Bazel. In case of any issues, please depend on the `tests.cmd` script mentioned in the [Running IntelliJ IDEA in CI/CD environment](#running-intellij-idea-in-cicd-environment) section.
### Opening the IntelliJ IDEA Source Code in the IDE
Using the latest IntelliJ IDEA, click '**File | Open**', select the `<IDEA_HOME>` directory.
If IntelliJ IDEA displays a message about a missing or out-of-date required plugin (e.g. Kotlin),
[enable, upgrade, or install that plugin](https://www.jetbrains.com/help/idea/managing-plugins.html) and restart IntelliJ IDEA.
### Opening the OpenIDE Source Code in the IDE
Using the latest OpenIDE, click '**File | Open**', select the `<IDEA_HOME>` directory.
If OpenIDE displays a message about a missing or out-of-date required plugin (e.g. Kotlin),
[enable, upgrade, or install that plugin](https://www.jetbrains.com/help/idea/managing-plugins.html) and restart OpenIDE.
### Build Configuration Steps
@@ -101,9 +86,9 @@ If IntelliJ IDEA displays a message about a missing or out-of-date required plug
- With notably higher available RAM, Increase "**User-local heap size**" to `3000`.
### Building the IntelliJ IDEA Application from Source
### Building the OpenIDE Application from Source
**To build IntelliJ IDEA from source**, choose '**Build | Build Project**' from the main menu.
**To build OpenIDE from source**, choose '**Build | Build Project**' from the main menu.
**To build installation packages**, run the [installers.cmd](installers.cmd) script in `<IDEA_HOME>` directory. `installers.cmd` will work on both Windows and Unix systems.
Options to build installers are passed as system properties to `installers.cmd` command.
@@ -120,7 +105,7 @@ Installer build examples:
> [!TIP]
>
> The `installers.cmd` is used to run [OpenSourceCommunityInstallersBuildTarget](build/src/OpenSourceCommunityInstallersBuildTarget.kt) from the command line.
> You can also call it directly from IDEA, using run configuration `Build IntelliJ IDEA Installers (current OS)`.
> You can also call it directly from IDEA, using run configuration `Build OpenIDE Installers (current OS)`.
> This prevents issues with permissions for the checked-out repository, the build output, if any.
---
## Running IntelliJ IDEA
To run the IntelliJ IDEA that was built from source, choose '**Run | Run**' from the main menu. This will use the preconfigured run configuration `IDEA`.
## Running OpenIDE
To run the OpenIDE that was built from source, choose '**Run | Run**' from the main menu. This will use the preconfigured run configuration `IDEA`.
To run tests on the build, apply these settings to the '**Run | Edit Configurations... | Templates | JUnit**' configuration tab:
* Working dir: `<IDEA_HOME>/bin`
* VM options: `-ea`
#### Running IntelliJ IDEA in CI/CD environment
#### Running OpenIDE in CI/CD environment
To run tests outside of IntelliJ IDEA, run the `tests.cmd` command in `<IDEA_HOME>` directory.`tests.cmd` can be used in both Windows and Unix systems.
To run tests outside of OpenIDE, run the `tests.cmd` command in `<IDEA_HOME>` directory.`tests.cmd` can be used in both Windows and Unix systems.
Options to run tests are passed as system properties to `tests.cmd` command.
You may find the list of available properties in [TestingOptions.kt](platform/build-scripts/src/org/jetbrains/intellij/build/TestingOptions.kt)
We do our best to make sure our software is free of any security vulnerabilities. The reality though is that it's not always the case.
That is why we are very eager and grateful to hear about any issues you find.
## Where to report issues
Please report these issues
* Directly to our [issue tracker](https://youtrack.jetbrains.com) setting issue type to `Security Problem` to limit visibility.
* Via email [security@jetbrains.com](mailto:security@jetbrains.com) encrypted with a [PGP key](https://www.jetbrains.com/privacy-security/), you can find this on most public key servers.
## Reporting conditions
Those reporting issues should conform to the following conditions:
* All communication and disclosure should be made in a coordinated manner, not putting our business or our users and customers at risk.
* The issue should contain a description and working proof of concept.
* There should not be any attacks that attempt to access JetBrains or our customers' confidential data.
* There should not be any attacks that lead to denial of service attacks on our systems and services or jeopardizing them in any way.
* No automated tools should be used for attacking our systems or services.
* No social engineering should be targeted against JetBrains employees or customers.
## Proof of concept
* Proof of concept should be drafted using your data when possible.
* The impact from the demonstration should be limited to the necessary minimum required to prove the concept.
* Where it is not possible to avoid interacting with real users or their data, the impact should be minimized to a few entries where it is absolutely necessary to demonstrate a vulnerability.
* The confidentiality, integrity, and availability of our products, services, data, and business processes are to be respected.
## Bug Bounty
We don't have a formal bug bounty program, but depending on the severity of the issue, we often reward reporters based on the issue score that we calculate according to [CVSS](https://www.first.org/cvss).
We determine the rewards at our discretion and on a case-by-case basis. The available reward options include financial rewards, swag, free licenses for JetBrains products, and mentioning a reporter in the JetBrains Security Bulletin.
The issue should not already have been announced publicly or known by JetBrains. This includes issues that we are aware of but have not yet disclosed publicly for whatever reasons.
## Timeline
* As soon as possible
* Triage reported vulnerabilities as soon as possible depending on their impact.
* Prevent further exposure of users data and further exploitation of a security issue.
* 24 hours from receiving the report
* Respond to your report with a confirmation of receipt and any questions, or an update on the planned course of action.
* With next release or bug fix update
* We release updated products with security fixes with the next release or bug fix update.
* Shortly after that we inform our customers about the vulnerability and recommend that they update to a more secure version of the product.
* Weeks following
* Announce the vulnerability and its fix on the [JetBrains Blog](https://blog.jetbrains.com) or the product blog. The exact number of weeks depends on multiple factors including planned time for our customers to update their software if necessary.
* Following quarter
* Announce vulnerabilities we've fixed over the past quarter in our [Security Bulletin](https://www.jetbrains.com/privacy-security/issues-fixed/)
that you can [subscribe to](https://www.jetbrains.com/security/subscribe).
If you have any questions or concerns regarding this policy, please reach out to [security@jetbrains.com](mailto:security@jetbrains.com).
<p>Неофициальный перевод предоставляется только для удобства понимания условий лицензии, однако юридически применимым
является только текст на английском языке.
</p>
<p>
Исходный код продукта доступен по адресу: <ahref="">наш репозиторий</a>.
</p>
<p>
Дистрибутив OpenIDE включает в себя JetBrains Runtime, распространяемый по лицензии GPL v 2.0. Исходный код
JetBrainsRuntime доступен по адресу:<br>
<ahref="">репозиторий</a>.
</p>
<p>
Вы можете расширять возможности OpenIDE, подключая или используя предустановленные сторонние аддоны,
размещенные по адресу <ahref="https://marketplace.openide.ru/page/1">marketplace.openide.ru</a>, либо доступные
из других источников. При работе с проектами посредством OpenIDE, вы также можете подключать к проекту сторонние
компоненты (такие как JDK). Такие аддоны или компоненты не являются частью OpenIDE и их использование регламентируется
собственными лицензиями. Информация о применимой лицензии указана в информации к каждому из аддонов и компонентов,
ознакомьтесь с условиями до скачивания/применения.
</p>
<p>
При использовании стороннего компонента Axiom JDK в составе проекта OpenIDE, Вы соглашаетесь с условиями
лицензии, размещенными по адресу: <ahref="https://axiomjdk.ru/axiomjdk-dev/">https://axiomjdk.ru/axiomjdk-dev/</a>
</p>
<p>
OpenIDE может собирать обезличенную статистику использования и передавать ее на сервера компании OpenIDE.
Такая статистика содержит только ограниченные данные технического характера, сбор информации, охраняемой
авторскими правами, законами о коммерческой или иной охраняемой тайне, а также персональных данных любого
рода, не производится. С механизмом сбора статистики можно ознакомиться в исходных кодах OpenIDE. Пользователь,
скачивая OpenIDE, соглашается с этим условием, однако может самостоятельно отключить отправку статистики во
всех версиях OpenIDE.
</p>
<h2>УЧАСТИЕ В ПРОЕКТЕ</h2>
<p>Мы приветствуем всех желающих внести свой вклад в развитие OpenIDE. Для участия в проекте вы можете:
<p>1. Написать нам на <ahref="mailto:xxx@xxx">xxx@xxx</a></p>
<p>2. Создать Pull Request в репозитории OpenIDE.</p>
<p>Предлагаемые вам изменения должны соответствовать правилам, указанным в <ahref="">ссылка на contributing.md</a></p>
<h2>ПОЛИТИКА КОНФИДЕНЦИАЛЬНОСТИ</h2>
<p>
Политику конфиденциальности можно найти на данном сайте, перейдя по <ahref="">этой ссылке</a>
</p>
</div>
</html>
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.