Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

#629: Enhanced commit documentation #630

Merged
merged 2 commits into from
Sep 19, 2024
Merged

#629: Enhanced commit documentation #630

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4798ba3
#629: Enhance commit documentation
jan-vcapgemini Sep 17, 2024
2138ed6
Merge branch 'main' into feature/629-recycle-commit-docs
hohwille Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions documentation/IDEasy-contribution-rules-and-guidelines.adoc
View file
Open in desktop
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
Loading