Browse Source

gh: some public facing changes

contributing is fine but the what is harvey section in read me
needs help.

Signed-off-by: Sevki <s@sevki.org>
Sevki 3 years ago
parent
commit
ae78aa62af
2 changed files with 63 additions and 2 deletions
  1. 57 2
      CONTRIBUTING.md
  2. 6 0
      README

+ 57 - 2
CONTRIBUTING.md

@@ -46,9 +46,9 @@ Harvey uses Github Pull Requests to accept contributions.
 	For example, @keedon selected the branch name `statscrash` for
     issue #70.
 3.  Make changes
-4.  Commit with a descriptive message:
+4.  Commit with a descriptive message and [signed-off-by:](https://github.com/docker/Harvey-OS/harvey/master/CONTRIBUTING.md#sign-your-work):
     ```
-    $ git commit -m "A brief summary of the commit
+    $ git commit -m -s "A brief summary of the commit
     >
     > A paragraph describing what changed and its impact."
     ```
@@ -127,6 +127,61 @@ conflict.
 - [Video: Undo, Redo & Rebase Your Git History](https://www.youtube.com/watch?v=W39CfI3-JFc)
 - [Video: Git Rebase](https://www.youtube.com/watch?v=SxzjZtJwOgo)
 
+### Sign your work
+
+The sign-off is a simple line at the end of the explanation for the patch. Your
+signature certifies that you wrote the patch or otherwise have the right to pass
+it on as an open-source patch. The rules are pretty simple: if you can certify
+the below (from [developercertificate.org](http://developercertificate.org/)):
+
+```
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+1 Letterman Drive
+Suite D4700
+San Francisco, CA, 94129
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
+```
+
+Then you just add a line to every git commit message:
+
+    Signed-off-by: Joe Smith <joe.smith@email.com>
+
+Use your real name (sorry, no pseudonyms or anonymous contributions.)
+
+If you set your `user.name` and `user.email` git configs, you can sign your
+commit automatically with `git commit -s`.
 
 ## Coding conventions
 

+ 6 - 0
README

@@ -5,6 +5,12 @@ Harvey: A distributed operating system
 Welcome to Harvey, we are delighted that you are interested in the
 project.
 
+## What is harvey?
+
+Harvey is a distributed operating system. It is direct descendant
+[Plan 9 from Bell Labs](https://en.wikipedia.org/wiki/Plan_9_from_Bell_Labs) which was originally
+developed by the same group at Bell Labs that developed Unix and C.
+
 - Take a look at the
   [Getting Started](https://github.com/Harvey-OS/harvey/wiki/Getting-Started)
   guide to learn how to get Harvey and how to play with it.