Skip to content

IDEasy-commit.adoc

Latest commit

 

History

History
27 lines (19 loc) · 981 Bytes

IDEasy-commit.adoc

File metadata and controls

27 lines (19 loc) · 981 Bytes

Commit

  • Commit messages should always start with the issue number and a hashtag 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:

#«issue-id»: «describe your change»

  • Then GitHub will automatically link the commit with the issue.

  • Example:

#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:

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

  • Example:

devonfw/IDEasy#5: added REST service for tablemanagement