You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+26Lines changed: 26 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -73,6 +73,32 @@ The project uses the following guidelines:
73
73
74
74
If in doubt, skim through the existing source code to get a feel for it.
75
75
76
+
## Conventional Commits for Changelogs
77
+
78
+
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/):
79
+
80
+
***build: message** -- change affects the build system, configuration files, scripts, or external dependencies
***refactor: message** -- change cleans up or restructures code
86
+
***test: message** -- change that adds new or updates existing tests
87
+
***repo: message** -- change that is related to repository maintenance
88
+
89
+
Examples:
90
+
91
+
*`build: use JDK 17 as baseline`
92
+
*`docs: update description of method X to match behavior`
93
+
94
+
If the commit type follows a `!`, then it is a breaking change.
95
+
Example: `refactor!: removed deprecated methods X and Y`
96
+
97
+
Optionally, the change scope can be provided. Example: `feat(core): message`.
98
+
99
+
If a commit does not follow the guidelines (i.e. no `:` character), then it is excluded from the changelog.
100
+
Hence, the `:` character is banned from non-changelog commit messages.
101
+
76
102
## Community Roles
77
103
78
104
Community developers may apply to any of these roles by opening an issue or discussing in the [community chat](https://gitter.im/AlmasB/FXGL). Each role is allocated based on discussions with the individual. The individual is expected to be **committed** to the role guidance. However, the role descriptions are merely a guidance and not binding in any way. The role may be revoked at the request of the individual or due to violation of the [Code of Conduct](CODE_OF_CONDUCT.md).
0 commit comments