Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | Next revisionBoth sides next revision | ||
contribute:dev:git:start [2020/06/19 13:12] – [GitLab Forks and Merge Requests] skunnyk | contribute:dev:git:start [2020/06/20 00:54] – Add Commit Guidelines andreldm | ||
---|---|---|---|
Line 69: | Line 69: | ||
* Write commit messages using the standard Git message format. | * Write commit messages using the standard Git message format. | ||
* Don't fear the rebase (against the Xfce master branch): you should fix the merge problems, not the developer. | * Don't fear the rebase (against the Xfce master branch): you should fix the merge problems, not the developer. | ||
+ | * Read the guidelines below | ||
+ | |||
+ | [[|Back To Top]] | ||
+ | |||
+ | |||
+ | ---- | ||
+ | ===== Commit Guidelines ===== | ||
+ | |||
+ | * The commit message is made of summary (first line), one empty line and the remaining lines are its description. | ||
+ | * Keep the summary short, aim for up to 72 characters. | ||
+ | * You're encouraged to write an extensive description when it makes sense, [[https:// | ||
+ | * Add reference to the related issue or merge request at the end of summary. | ||
+ | * Reference for an issue: " | ||
+ | * Reference for a merge request: "Add new app icon (!11)" | ||
+ | * When a commit relates to an issue and a merge request, only add the former to the summary and mention the latter in the description. | ||
+ | * Optionally Sign Off your commits (mandatory for Xfwm4!). | ||
+ | * GitLab' | ||
+ | * When makes isolated changes, such a single part of the project or one of its plugins, please add a lowercase label as the summary prefix, examples: | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
[[|Back To Top]] | [[|Back To Top]] |