README: suggest fetching the remote before merging a branch
[signed-off-by.git] / README
1 Do you want explicit licensing and publishing permissions for each
2 patch you incorperate 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. Merge the documentation into your project:
9
10     $ git remote add s-o-b git://tremily.us/signed-off-by.git
11     $ git fetch s-o-b
12     $ git merge s-o-b/signed-off-by
13
14 2. Tell your developers by pointing to
15    `Documentation/SubmittingPatches` from your `README` or
16    `CONTRIBUTING` documentation and sending a message to your mailing
17    list.
18
19 3. Prosper.
20
21 Branches
22 ========
23
24 To make it easier to merge bits and pieces of this documentation into
25 your project, I've split the contents into several branches:
26
27 master:
28   This branch, mostly a container for this `README`.
29
30 signed-off-by:
31   `Documentation/SubmittingPatches`, this is what you want in your
32   project.
33
34 copying:
35   The license under which `Documentation/SubmittingPatches` is
36   distributed.  Check here to determine if you are allowed to merge
37   `signed-off-by` into your project.
38
39 contributing:
40   An example `CONTRIBUTING` file in case your license does not allow
41   you to merge `signed-off-by`.  The contributing file is released
42   under the very permissive CC0 1.0 unported.
43
44 contributing-github:
45   A version of the `contributing` branch adapted for GitHub-based
46   projects.
47
48 license:
49   The text of all the licenses related to this repository.  Inludes
50   `GPLv2-exact` for `SubmittingPatches`, `CC0-1.0` for `CONTRIBUTING`,
51   and `CC-BY-3.0` for `CC0-1.01`.  It also includes the short,
52   human-readable versions of the CC licenses.
53
54 Borrowed commits
55 ================
56
57 For work that started in other projects (e.g. the Linux kernel and
58 Git), I've cherry-picked the relevant commits from the project
59 repositories to preserve commit metadata.  For each of these commits,
60 I've attached a note with the commit hash, original commit message,
61 and original commit repository.  Fetch the `refs/notes/commits`
62 reference from my public repository if you want these notes:
63
64   $ git config --add remote.origin.fetch '+refs/notes/*:refs/notes/*'
65   $ git fetch origin
66
67 If I altered the original patch by removing context, I've added my
68 s-o-b.  Otherwise the original patch applied cleanly, and I left my
69 s-o-b off.