README: Suggest signoffs for merge commits
[signed-off-by.git] / README
1 Do you want explicit licensing and publishing permissions for each
2 patch you incorporate into your project?  Do you miss the simplicity
3 of Signed-off-by tags you use when developing the Linux kernel and
4 Git?  This repository extracts the Developer Certificate of Origin and
5 Signed-off-by documentation from both projects, and presents them in a
6 project-agnostic manner.  To incorporate into your own project,
7
8 1. Pull the documentation into your project:
9
10      $ git pull --allow-unrelated-histories git://tremily.us/signed-off-by.git signed-off-by
11
12    Alternatively, you may pull in one of the other branches listed below, for example:
13
14      $ git pull --allow-unrelated-histories git://tremily.us/signed-off-by.git contributing-github
15
16    If you like signing merges, you may want to run:
17
18      $ git commit --amend --signoff --no-edit
19
20 2. Tell your developers by pointing to
21    `Documentation/SubmittingPatches` from your `README` or
22    `CONTRIBUTING` documentation and sending a message to your mailing
23    list.
24
25 3. Prosper.
26
27 Branches
28 ========
29
30 To make it easier to merge bits and pieces of this documentation into
31 your project, I've split the contents into several branches:
32
33 master:
34   This branch, mostly a container for this `README`.
35
36 signed-off-by:
37   `Documentation/developer-certificate-of-origin` contains the full
38   text of the DCO (verbatim copies only), and
39   `Documentation/SubmittingPatches` (GPLv2-exact) explains how to
40   use the DCO with Signed-off-by tags.
41
42 copying:
43   The license under which `Documentation/SubmittingPatches` is
44   distributed.  Check here to determine if you are allowed to merge
45   `signed-off-by` into your project.
46
47 contributing:
48   An example `CONTRIBUTING` file in case your license does not allow
49   you to merge `signed-off-by`.  The contributing file is released
50   under the very permissive CC0 1.0 unported.
51
52 contributing-github:
53   A version of the `contributing` branch adapted for GitHub-based
54   projects.
55
56 license:
57   The text of all the licenses related to this repository.  Includes
58   `GPLv2-exact` for `SubmittingPatches`, `CC0-1.0` for `CONTRIBUTING`,
59   and `CC-BY-3.0` for `CC0-1.0`.  It also includes the short,
60   human-readable versions of the CC licenses.
61
62 Borrowed commits
63 ================
64
65 For work that started in other projects (e.g. the Linux kernel and
66 Git), I've cherry-picked the relevant commits from the project
67 repositories to preserve commit metadata.  For each of these commits,
68 I've attached a note with the commit hash, original commit message,
69 and original commit repository.  Fetch the `refs/notes/commits`
70 reference from my public repository if you want these notes:
71
72   $ git config --add remote.origin.fetch '+refs/notes/*:refs/notes/*'
73   $ git fetch origin
74
75 If I altered the original patch by removing context, I've added my
76 s-o-b.  Otherwise the original patch applied cleanly, and I left my
77 s-o-b off.