Xfce Wiki

Sub domains
 

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
contribute:dev:git:start [2020/05/14 01:37] – [GitLab Forks and Merge Requests] ochosicontribute: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://gitlab.xfce.org/xfce/xfwm4/-/commit/49c1a33a4dfe15f312334584c22b4ec3ed792214|example]]
 +  * Add reference to the related issue or merge request at the end of summary.
 +    * Reference for an issue: "Shorten strings in Arrange Items submenu (#247)"
 +    * 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's [[https://docs.gitlab.com/ce/user/project/issues/managing_issues.html#default-closing-pattern|closing patterns]] such as ''fixes'' and ''closes'' should go into the commit description, never in the summary.
 +  * 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:
 +    * "mime-helpers: Rename Thunar to thunar"
 +    * "action buttons: Fix separator width"
 +    * "tasklist: Allow keyboard navigation within groups (#270)"
  
 [[|Back To Top]] [[|Back To Top]]
Line 79: Line 100:
   - Fork the project   - Fork the project
   - Clone your fork   - Clone your fork
-  - Create a new branch+  - Create a new branch (try to use a descriptive name), don't use "master"
   - Change and push your code to your fork/branch   - Change and push your code to your fork/branch
   - Start a merge request and [[https://docs.gitlab.com/ee/user/project/merge_requests/allow_collaboration.html|allow maintainers to change your branch]] (this means maintainers can rebase your branch on top of master using the GitLab Web UI)   - Start a merge request and [[https://docs.gitlab.com/ee/user/project/merge_requests/allow_collaboration.html|allow maintainers to change your branch]] (this means maintainers can rebase your branch on top of master using the GitLab Web UI)