Skip to content

Commit 8e671c8

Browse files
committed
docs: updated to match JDK 21 baseline, simplify wording
1 parent 3815f52 commit 8e671c8

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ All the work goes to your `dev` branch, then pull a request back to `dev`.
2626
## Development
2727

2828
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:
3030

3131
1. Fork FXGL into your GitHub repo, then clone your repo to your machine.
3232
2. Open IDEA -> File -> New -> Project from Existing Sources -> Select the cloned FXGL directory.
3333
3. Import project from external model -> Maven -> Finish.
3434

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.
3636

3737
You should now see something like this:
3838

@@ -51,14 +51,13 @@ In IntelliJ,
5151
1. Run -> Edit Configurations
5252
2. Add new JUnit configuration with name "ALL FXGL TESTS"
5353
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.
5556

5657
<img src="https://raw.githubusercontent.com/AlmasB/git-server/master/storage/images/fxgl11_tests.jpg" width="400" />
5758

5859
Now you can run your configuration "ALL FXGL TESTS" which runs tests from all modules.
5960

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-
6261
## Coding Standards
6362

6463
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.
7473

7574
## Conventional Commits for Changelogs
7675

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/):
7877

7978
* **build: message** -- change affects the build system, configuration files, scripts, or external dependencies
8079
* **docs: message** -- change affects documentation **only**
@@ -87,15 +86,10 @@ From version 17, the project uses the following commit message guidelines to aut
8786

8887
Examples:
8988

90-
* `build: use JDK 17 as baseline`
89+
* `build: use latest JDK as baseline`
9190
* `docs: update description of method X to match behavior`
9291

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.
9993
Hence, the `:` character is banned from non-changelog commit messages.
10094

10195
## Community Roles

0 commit comments

Comments
 (0)