Skip to content

Commit

Permalink
#629: Enhance commit documentation (#630)
Browse files Browse the repository at this point in the history
  • Loading branch information
jan-vcapgemini authored Sep 19, 2024
1 parent 28e8782 commit 5525223
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions documentation/IDEasy-contribution-rules-and-guidelines.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,28 @@ The following conventions are added on top by the IDEasy team from the learnings
* Commit messages should always start with the issue number and a hashtag, so to automatically link the corresponding issue.
* The title of a commit should be kept short and informative.
* The description of a commit message can be used to elaborate on the title.
* Always commit your changes in small logical units associated with an issue (see above section) using the commit message format:

[source]
#«issue-id»: «describe your change»

* Then GitHub will automatically link the commit with the issue.
* Example:

[source]
#1: added REST service for tablemanagement
Implemented REST TableManagement class
Added unit tests for TableManagement class

* In case you worked on an issue from a different repository (e.g. change in `ide-settings` due to an issue in `IDEasy`), we use this commit message format:

[source]
«organization»/«repository»#«issue-id»: «describe your change»

* Example:

[source]
devonfw/IDEasy/#5: added REST service for tablemanagement

== Issue

Expand Down

0 comments on commit 5525223

Please sign in to comment.