Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
dev:howto:contribute [2013/02/02 13:08] – jannis | dev:howto:contribute [2013/02/02 13:36] – [Contribution Process] jannis | ||
---|---|---|---|
Line 24: | Line 24: | ||
The current recommended (but undocumented) way to get started essentially is: subscribe to [[https:// | The current recommended (but undocumented) way to get started essentially is: subscribe to [[https:// | ||
+ | |||
+ | ===== Proposals ===== | ||
+ | |||
+ | ==== Presenting Low-Hanging Fruit ==== | ||
+ | |||
+ | ==== Contribution Process ==== | ||
+ | |||
+ | === 1. Clone and branch === | ||
+ | |||
+ | When you start working on a fix or new feature, clone the relevant repository (e.g. Thunar) and branch off the main development branch (master): | ||
+ | |||
+ | git clone git:// | ||
+ | cd thunar | ||
+ | git checkout -b <your name>/< | ||
+ | |||
+ | === 2. Write code === | ||
+ | |||
+ | Work on your fix or feature in the branch you created. Important: | ||
+ | |||
+ | * Make sure to commit frequently. | ||
+ | * Keep commits clean: | ||
+ | * 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 master) to reorder, reorganize and rewrite your branch to keep it clean | ||
+ | |||
+ | === 3. Push === | ||
+ | |||
+ | Before submitting your changes for review, it is a good idea to push them to a public repository, e.g. on GitHub. This will make it easier for others to check out your branch and test it as part of their reviews. | ||
+ | |||
+ | === 4. Submit for review === | ||
+ | |||
+ | Submitting your changes for review is as simple as running a single Git command. In your branch, run: | ||
+ | |||
+ | git send-email --suppress-cc=self --annotate --cover-letter origin/ | ||
+ | |||
+ | This will drop you in an editor where you are being asked to define a subject and a message for the patch set you are submitting. The editor window will roughly look like this: | ||
+ | |||
+ | From 451e2ab7ea3d595476ec5e57f33da8eef1661773 Mon Sep 17 00:00:00 2001 | ||
+ | From: Jannis Pohlmann | ||
+ | Date: Thu, 10 Jan 2013 09:25:18 +0100 | ||
+ | Subject: [PATCH 0/2] ***SUBJECT*** | ||
+ | | ||
+ | ***MESSAGE*** | ||
+ | |||
+ | ... auto-generated git log and diff stats ... | ||
+ | |||
+ | Fill out the SUBJECT and MESSAGE by briefly describing what you are submitting. Then save the file and close the editor. '' | ||
+ | |||
+ | === 5. Review === | ||
+ | |||
+ | === 6. Merge === |