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:23] – [Setting your Git credentials] 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. | ||
+ | |||
+ | ---- | ||
===== Setting your Git credentials ===== | ===== Setting your Git credentials ===== | ||
Line 39: | Line 48: | ||
[[|Back To Top]] | [[|Back To Top]] | ||
---- | ---- | ||
+ | |||
===== Git usage example on an Xfce project ===== | ===== Git usage example on an Xfce project ===== | ||
- | 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 [[http://git.xfce.org|Git browser]]. | + | 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://gitlab.xfce.org|Git browser]]. |
- | In the example below, we do some tasks in the [[http://git.xfce.org/ | + | 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 57: | 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 and commit them | + | |
- | git commit | + | |
- | + | ||
- | # In case upstream changed a lot... | + | |
- | 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 | + | |
- | + | ||
- | </ | + | |
- | + | ||
- | In the output directory you should find various '' | + | |
- | + | ||
- | What ever you do, keep commits clean: | + | |
* Make incremental, | * Make incremental, | ||
Line 94: | Line 78: | ||
* 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]] | [[|Back To Top]] | ||
+ | |||
---- | ---- | ||
- | ===== Git permission on git.xfce.org ===== | ||
- | <note tip> | + | ===== Commit Guidelines ===== |
- | There are a number | + | * The commit message is made of summary |
+ | * 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 in the description. | ||
+ | * 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: | ||
+ | * " | ||
+ | * " | ||
+ | * " | ||
- | To list all your permissions and repositories you can access to, run the following command: | + | [[|Back |
- | <file bash> | ||
- | # W means you can write, R is read-only | ||
- | ssh git@git.xfce.org info | ||
- | </ | ||
- | For non-user repositories the following rules apply as well: | + | ---- |
- | * You can only push fast-forward commits (upstream can not loose refs) | + | ===== GitLab Forks and Merge Requests ===== |
- | | + | |
- | | + | If you want to contribute code, the best way is to get a contributor' |
- | * Only annotated tags are allowed, tags cannot | + | |
+ | | ||
+ | | ||
+ | | ||
+ | - Change and push your code to your fork/ | ||
+ | - Start a merge request and [[https:// | ||
+ | - Wait patiently | ||
[[|Back To Top]] | [[|Back To Top]] | ||
+ | |||
+ | |||
---- | ---- | ||
- | ===== Git repository description ===== | ||
- | Set the '' | + | ===== Git rules on gitlab.xfce.org |
- | <file bash>ssh git@git.xfce.org desc users/ | + | The following rules apply: |
- | Every user with write access to the repository | + | * You can only push fast-forward commits (upstream can not lose refs) |
+ | * Email addresses of each commit are validated | ||
+ | * Only annotated tags are allowed, tags cannot be deleted | ||
[[|Back To Top]] | [[|Back To Top]] | ||
---- | ---- | ||
- | ===== Adding and removing private keys ===== | ||
- | TODO SSKM | + | ===== Git repository description ===== |
+ | |||
+ | The repository description shall be set via a Readme markdown file. See the [[https:// | ||
+ | |||
+ | [[|Back To Top]] | ||
+ | ---- | ||
+ | [[: |