diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 120000 index 000000000..3f7568eb2 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1 @@ +HACKING \ No newline at end of file diff --git a/HACKING b/HACKING index 0f837083b..7b7a6d3f2 100644 --- a/HACKING +++ b/HACKING @@ -62,10 +62,16 @@ Remember: Submitting Patches ------------------ -Use 'git format-patch' to generate patches against a checked out copy -of the source. +We prefer patches submitted as pull requests to our GitHub project at +https://github.com/PackageKit/PackageKit -For Example: +However, if you are unable to use GitHub, you can also submit patches +via email. + +To do so, Use 'git format-patch' to generate patches against a checked +out copy of the source. + +For example: $> cd PackageKit HACK HACK HACK @@ -79,3 +85,29 @@ For Example: Send these patches in an introductory email as attachments to packagekit@lists.freedesktop.org +Commit/Patch Style +------------------ +Commits (and thus patches) should be structured such that each one +is a logically distinct change that stands well and can be tested +on its own. + +Commit/Patch messages should be wrapped at 72 characters, and the +subject line (minus the subsystem prefix) should be less than 50 +characters. + +What we mean by subsystem prefix is the portion of the codebase +that is being modified. + +For example, if you are changing something in the main library, +use "lib:" as the prefix of the patch subject. If you are +changing something in one of the backends, use the backend name +as the prefix in the patch subject. + +There are a number of examples of this already in the revision +history, so look at any number of them for good examples. + +Finally, please do not use commit messages as a means for +advertising. The revision history is not a place for rent-free +permanent advertising. It can be especially problematic as +sponsoring entities change, rename, or such. That means that +tags like "Sponsored-by" or similar are not allowed.