diff options
| author |  Kristóf Marussy <kristof@marussy.com> | 2024-04-09 16:07:45 +0200 |
|---|---|---|
| committer | Kristóf Marussy <kristof@marussy.com> | 2024-04-09 16:07:45 +0200 |
| commit | 4ce6123378600e6fa5a6543dbf7c45a49e11076e (patch) | |
| tree | a18575c02e82ce13727cd67012901b7bc8e3b324 /CONTRIBUTING.md | |
| parent | docs: add Docusaurus website (diff) | |
| download | refinery-4ce6123378600e6fa5a6543dbf7c45a49e11076e.tar.gz refinery-4ce6123378600e6fa5a6543dbf7c45a49e11076e.tar.zst refinery-4ce6123378600e6fa5a6543dbf7c45a49e11076e.zip | |
docs: basic theme and structure
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index a5f1594a..00000000 --- a/CONTRIBUTING.md +++ /dev/null | |||
| @@ -1,51 +0,0 @@ | |||
| 1 | <!-- | ||
| 2 | SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/> | ||
| 3 | |||
| 4 | SPDX-License-Identifier: EPL-2.0 | ||
| 5 | --> | ||
| 6 | |||
| 7 | # Contributing to Refinery | ||
| 8 | |||
| 9 | ## Setting up the development environment | ||
| 10 | |||
| 11 | ### With IntelliJ IDEA | ||
| 12 | |||
| 13 | We prefer IntelliJ IDEA as a development environment. | ||
| 14 | No special preparations should be necessary for importing the project as a Gradle project into IDEA. | ||
| 15 | |||
| 16 | However, you will need Eclipse to edit Xtext (`*.xtext`) and MWE2 (`*.mwe2`) files and Ecore class diagrams (`*.aird`, `*.ecore`, `*.genmodel`). | ||
| 17 | If you do not plan on making changes to such files, feel free to skip the Eclipse installation steps below. | ||
| 18 | |||
| 19 | ### With Eclipse IDE | ||
| 20 | |||
| 21 | 1. Download and install a _Java 21_ compatible JDK. For Windows, prefer OpenJDK builds from [Adoptium](https://adoptium.net/). | ||
| 22 | |||
| 23 | 2. Download and extract the [Eclipse IDE for Java and DSL Developers 2023-12](https://www.eclipse.org/downloads/packages/release/2023-12/r/eclipse-ide-java-and-dsl-developers) package. | ||
| 24 | |||
| 25 | 3. Launch Eclipse and create a new workspace. | ||
| 26 | |||
| 27 | 4. Open _Help > Eclipse Marketplace_ and install the following software: | ||
| 28 | * _EclEmma Java Code Coverage_ | ||
| 29 | * _EcoreTools : Ecore Diagram Editor_ | ||
| 30 | * _Sirius_ (ignore the warning during installation about the solution _Sirius_ not being available) | ||
| 31 | * _SonarLint_ | ||
| 32 | |||
| 33 | 5. Open _Window > Preferences_ and set the following preferences: | ||
| 34 | * _General > Workspace > Text file encoding_ should be _UTF-8_. | ||
| 35 | * _General > Workspace > New text file line delimiter_ should be _Unix_. | ||
| 36 | * Add the JDK 21 to _Java > Installed JREs_. | ||
| 37 | * Make sure JDK 21 is selected for _JavaSE-21_ at _Java > Installed JREs > Execution Environments_. | ||
| 38 | * Set _Gradle > Java home_ to the `JAVA_HOME` directory (the directory which contains the `bin` directory) of JDK 21. Here, Buildship will show a yellow warning sign, which can be safely ignored. | ||
| 39 | * Set _Java > Compiler > JDK Compliance > Compiler compliance level_ to _21_. | ||
| 40 | |||
| 41 | 6. Clone the project Git repository but do not import it into Eclipse yet. | ||
| 42 | |||
| 43 | 7. Open a new terminal an run `./gradlew prepareEclipse` (`.\gradlew prepareEclipse` on Windows) in the cloned repository. | ||
| 44 | * This should complete without any compilation errors. | ||
| 45 | * If you get any errors about the JVM version, check whether the `JAVA_HOME` environment variable is set to the location of JDK. You can query the variable with `echo $JAVA_HOME` on Linux and `echo $Env:JAVA_HOME` in PowerShell on Windows. To set it, use `export JAVA_HOME=/java/path/here` or `$Env:JAVA_HOME="C:\java\path\here"`, respectively. | ||
| 46 | * If the build fails with a `Host name must not be empty` error, you [might need to remove the empty proxy configuration from your global `gradle.properties` file](https://stackoverflow.com/a/62128323). | ||
| 47 | |||
| 48 | 8. Select _File > Import... > Gradle > Existing Gradle Project_ and import the cloned repository in Eclipse. | ||
| 49 | * Make sure to select the root of the repository (containing this file) as the _Project root directory_ and that the _Gradle distribution_ is _Gradle wrapper_. | ||
| 50 | * If you have previously imported the project into Eclipse, this step will likely fail. In that case, you should remove the projects from Eclipse, run `git clean -fxd` in the repository, and start over from step 8. | ||
| 51 | |||