Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
contribute:dev:git:start [2019/09/08 00:19] – [Using Git within the Xfce development workflow] kevinbowen | contribute:dev:git:start [2024/04/14 10:35] (current) – [GitLab Forks and Merge Requests] gael | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ~~NOTOC~~ | ||
====== Using Git within the Xfce development workflow ====== | ====== Using Git within the Xfce development workflow ====== | ||
* **[[start# | * **[[start# | ||
* **[[start# | * **[[start# | ||
- | * **[[start# | + | * **[[start# |
- | * **[[start# | + | * **[[start# |
+ | * **[[start# | ||
+ | * **[[start# | ||
* **[[start# | * **[[start# | ||
+ | * **[[: | ||
+ | |||
+ | ---- | ||
===== Introduction ===== | ===== Introduction ===== | ||
Xfce uses Git as distributed version control system (DCVS) for all the code contributed by developers. On this page, we will explain the basics and initial setup needed to get started developing for Xfce. However, if you want to know it all about Git, look at the following websites for a more in depth examination of Git and its usage: | Xfce uses Git as distributed version control system (DCVS) for all the code contributed by developers. On this page, we will explain the basics and initial setup needed to get started developing for Xfce. However, if you want to know it all about Git, look at the following websites for a more in depth examination of Git and its usage: | ||
+ | |||
+ | ---- | ||
=== Git resources === | === Git resources === | ||
* [[https:// | * [[https:// | ||
- | * [[https:// | + | |
+ | | ||
* Use '' | * Use '' | ||
* Your favorite search engine | * Your favorite search engine | ||
Line 21: | Line 30: | ||
* **[[tips-and-tricks|Tips and Tricks]]** -- Some additional functionality that is nice to know. | * **[[tips-and-tricks|Tips and Tricks]]** -- Some additional functionality that is nice to know. | ||
- | |||
- | * **[[userrepos|Xfce user repositories]]** -- How to create a user repository on [[https:// | ||
* **[[github|GitHub mirror]]** -- What we do with the GitHub mirror of the Xfce repositories. | * **[[github|GitHub mirror]]** -- What we do with the GitHub mirror of the Xfce repositories. | ||
- | ===== Set your credentials ===== | + | ---- |
+ | |||
+ | ===== Setting | ||
Before you even think about committing changes, you must set your name and email address to something valid in your **local** Git config: | Before you even think about committing changes, you must set your name and email address to something valid in your **local** Git config: | ||
Line 37: | Line 46: | ||
Make sure the email address is a __valid__ address, there is a hook on the server that checks the address of every new commit. | Make sure the email address is a __valid__ address, there is a hook on the server that checks the address of every new commit. | ||
- | ===== Usage ===== | + | [[|Back To Top]] |
+ | ---- | ||
- | The intention, here, is not to fully explain | + | ===== Git usage example |
- | In the example below, we do some tasks in the [[http://git.xfce.org/ | + | The intention, here, is not to fully explain Git; but, only provide a short introduction on how it works to get you started working with Xfce's development workflow. You can find the clone URL in the summary page of each repository in the [[https:// |
+ | |||
+ | In the example below, we do some tasks in the [[https://gitlab.xfce.org/ | ||
<file bash> | <file bash> | ||
# Make a local clone of the upstream repository | # Make a local clone of the upstream repository | ||
- | git clone git://git.xfce.org/ | + | git clone https://gitlab.xfce.org/ |
# To keep the local copy updated with upstream you can run this from time to time | # To keep the local copy updated with upstream you can run this from time to time | ||
Line 55: | Line 67: | ||
git diff | git diff | ||
git status | git status | ||
- | |||
- | # Redirect to a patch for in bugzilla (without credits and message) | ||
- | git diff > ~/ | ||
</ | </ | ||
- | In case the changes are more invasive, it is best to work in a separate branch. You can there commit all the individual modifications | + | In order to propose your changes you can **fork |
- | <file bash> | + | **What ever you do, keep commits clean:** |
- | # Create a branch to work in | + | |
- | git checkout -b my-fix-for-1234 | + | |
- | # Make changes | + | * Make incremental, |
- | git commit | + | * Keep code working after every commit. |
+ | * Comment the code you write. | ||
+ | * Write commit | ||
+ | * Don't fear the rebase (against the Xfce master branch): you should fix the merge problems, not the developer. | ||
+ | * Read the guidelines below | ||
- | # In case upstream changed a lot... | + | [[|Back To Top]] |
- | git checkout master | + | |
- | git pull # pull the latest upstream changes | + | |
- | git checkout my-fix-for-1234 # switch back to your branch | + | |
- | git rebase master | + | |
- | # Time to create the patches (that are in your branch and not in master) | ||
- | git format-patch -o ~/ | ||
- | # If you have multiple (e.g. 5) patches, put them in a single file like that: | + | ---- |
- | git format-patch -5 --stdout > multi_commit.patch | + | |
- | </ | + | ===== Commit Guidelines ===== |
- | In the output directory you should find various '' | + | * The commit |
+ | * 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 | ||
+ | * 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 | ||
+ | * Optionally Sign Off your commits (mandatory for Xfwm4!). | ||
+ | * GitLab' | ||
+ | * When making isolated changes, such as in a single part of the project or one of its plugins, please add a lowercase label as the summary prefix, examples: | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
- | What ever you do, keep commits clean: | + | [[|Back To Top]] |
- | * Make incremental, | ||
- | * Keep code working after every commit. | ||
- | * Comment the code you write. | ||
- | * 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. | ||
+ | ---- | ||
- | ===== Permissions | + | ===== GitLab Forks and Merge Requests |
- | <note tip> | + | If you want to contribute code, the best way is to get a contributor' |
+ | | ||
+ | - Fork the project via the GitLab UI | ||
+ | - Clone your fork locally | ||
+ | - **Create a new branch** (try to use a descriptive name), don't use " | ||
+ | | ||
+ | | ||
+ | - Wait patiently | ||
- | There are a number of rules we enforce in the upstream repositories. If you are experimenting with code (and thus working with more branches and rebasing) it is therefore advised to do this in a [[userrepos|user repository]] and wait with the merge upstream when everything is ready. | + | [[|Back To Top]] |
- | To list all your permissions and repositories you can access to, run the following command: | ||
- | <file bash> | + | ---- |
- | # W means you can write, R is read-only | + | |
- | ssh git@git.xfce.org info | + | |
- | </ | + | |
- | For non-user repositories the following | + | ===== Git rules on gitlab.xfce.org ===== |
- | | + | The following rules apply: |
+ | |||
+ | | ||
* Email addresses of each commit are validated | * Email addresses of each commit are validated | ||
- | * You can only create and delete branches starting with your '' | ||
* Only annotated tags are allowed, tags cannot be deleted | * Only annotated tags are allowed, tags cannot be deleted | ||
- | ===== Repository description ===== | + | [[|Back To Top]] |
- | + | ---- | |
- | Set the '' | + | |
- | + | ||
- | <file bash>ssh git@git.xfce.org desc users/ | + | |
- | Every user with write access to the repository | + | ===== Git repository description |
- | ===== Adding and removing private keys ===== | + | The repository description shall be set via a Readme markdown file. See the [[https:// |
- | TODO SSKM | + | [[|Back To Top]] |
+ | ---- | ||
+ | [[: |