+7
-13
lines changedFilter options
+7
-13
lines changed Original file line number Diff line number Diff line change
@@ -26,13 +26,13 @@ All the work goes to your `dev` branch, then pull a request back to `dev`.
26 26
## Development
27 27 28 28
Due to use of Kotlin, [IntelliJ IDEA](https://www.jetbrains.com/idea/) is recommended.
29 -
To start developing FXGL you can set up IDEA (2021.3+) as follows:
29 +
To start developing FXGL you can set up IDEA (2023.2+) as follows:
30 30 31 31
1. Fork FXGL into your GitHub repo, then clone your repo to your machine.
32 32
2. Open IDEA -> File -> New -> Project from Existing Sources -> Select the cloned FXGL directory.
33 33
3. Import project from external model -> Maven -> Finish.
34 34 35 -
Ensure you are using [JDK 17](https://jdk.java.net/) (or higher). You can set this via File -> Project Structure -> Project.
35 +
Ensure you are using [JDK 21](https://jdk.java.net/) (or higher). You can set this via File -> Project Structure -> Project.
36 36 37 37
You should now see something like this:
38 38
@@ -51,14 +51,13 @@ In IntelliJ,
51 51
1. Run -> Edit Configurations
52 52
2. Add new JUnit configuration with name "ALL FXGL TESTS"
53 53
3. Select "Test kind" - "All in package" and "Search for tests" - "In whole project".
54 -
4. Apply -> OK.
54 +
4. Clear the "working directory" text field.
55 +
5. Apply -> OK.
55 56 56 57
<img src="https://raw.githubusercontent.com/AlmasB/git-server/master/storage/images/fxgl11_tests.jpg" width="400" />
57 58 58 59
Now you can run your configuration "ALL FXGL TESTS" which runs tests from all modules.
59 60 60 -
**Note:** if you encounter errors, such as "Cannot create process = 206", go to Edit Configurations again and clear the "working directory" text field.
61 - 62 61
## Coding Standards
63 62 64 63
The project uses the following guidelines:
@@ -74,7 +73,7 @@ If in doubt, skim through the existing source code to get a feel for it.
74 73 75 74
## Conventional Commits for Changelogs
76 75 77 -
From version 17, the project uses the following commit message guidelines to auto-generate changelogs, based on [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/):
76 +
The project uses the following commit message guidelines to auto-generate changelogs, mostly based on [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/):
78 77 79 78
* **build: message** -- change affects the build system, configuration files, scripts, or external dependencies
80 79
* **docs: message** -- change affects documentation **only**
@@ -87,15 +86,10 @@ From version 17, the project uses the following commit message guidelines to aut
87 86 88 87
Examples:
89 88 90 -
* `build: use JDK 17 as baseline`
89 +
* `build: use latest JDK as baseline`
91 90
* `docs: update description of method X to match behavior`
92 91 93 -
If the commit type follows a `!`, then it is a breaking change.
94 -
Example: `refactor!: removed deprecated methods X and Y`
95 - 96 -
Optionally, the change scope can be provided. Example: `feat(core): message`.
97 - 98 -
If a commit does not follow the guidelines (i.e. no `:` character), then it is excluded from the changelog.
92 +
If a commit does not have the `:` character, then it is excluded from the changelog.
99 93
Hence, the `:` character is banned from non-changelog commit messages.
100 94 101 95
## Community Roles
You can’t perform that action at this time.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4