On Wed, May 16, 2018 at 03:46:06PM +0100, Grant Likely wrote:
To match convention used by many projects on GitHub, put the contribution details into a separate file instead of the top level README. Also tighten up some of the language around contributing to be clearer.
Suggested-by: Jilayne Lovejoy jilayne.lovejoy@arm.com Signed-off-by: Grant Likely grant.likely@arm.com
CONTRIBUTING.rst | 70 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Makefile | 2 +- README.rst | 67 ++++------------------------------------------------- source/ebbr.rst | 4 ++-- 4 files changed, 78 insertions(+), 65 deletions(-) create mode 100644 CONTRIBUTING.rst
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..e101e5f --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,70 @@ +Contributing +============
+Master copy of this project is hosted on GitHub: +https://github.com/ARM-software/ebbr
+Anyone may contribute to the EBBR project. +Contributions are licensed under CC-BY-SA-4.0_ and must be made with a +Developer Certificate of Origin (DCO_) attestation as described below.
+EBBR discussion uses the boot-architecture_ and arm.ebbr-discuss mailing lists. +The 'official' list is arm.ebbr-discuss, but the list archives are not +yet public, so boot-architecture_ is being used to keep everything in +the open.
+* boot-architechture@lists.linaro.org
That is not how you spell "architecture" (as I just discovered when I copy 'n pasted from the current README).
Once that is fixed: Reviewed-by: Daniel Thompson daniel.thompson@linaro.org
Daniel.
+* arm.ebbr-discuss@arm.com
+Past discussions can be found in the boot-architecture-archive_.
+We use the IRC channel `#ebbr`_ on OFTC_.
+DCO Attestation +---------------
+To help track the origin of contributions, this project uses the same +DCO_ "sign-off" process as used by the Linux kernel. +The sign-off is a simple line at the end of the explanation for the +patch, which certifies that you wrote it 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:
+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 Ihave the right to submit it under the open source licenseindicated in the file; or(b) The contribution is based upon previous work that, to the bestof my knowledge, is covered under an appropriate open sourcelicense and I have the right under that license to submit thatwork with modifications, whether created in whole or in partby me, under the same open source license (unless I ampermitted to submit under a different license), as indicatedin the file; or(c) The contribution was provided directly to me by some otherperson who certified (a), (b) or (c) and I have not modifiedit.(d) I understand and agree that this project and the contributionare public and that a record of the contribution (including allpersonal information I submit with it, including my sign-off) ismaintained indefinitely and may be redistributed consistent withthis project or the open source license(s) involved.+then you just add a line saying::
Signed-off-by: Random J Developer <random@developer.example.org>+.. _CC-BY-SA-4.0: LICENSE +.. _#ebbr: https://webchat.oftc.net/?channels=%23ebbr&uio=d4 +.. _OFTC: https://www.oftc.net/ +.. _DCO: https://developercertificate.org/ +.. _boot-architecture: https://lists.linaro.org/mailman/listinfo/boot-architecture +.. _boot-architecture-archive: https://lists.linaro.org/pipermail/boot-architecture
diff --git a/Makefile b/Makefile index 91bb4be..46ed82a 100644 --- a/Makefile +++ b/Makefile @@ -17,4 +17,4 @@ help: # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile
- @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
- @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/README.rst b/README.rst index 57fac8f..67c7e85 100644 --- a/README.rst +++ b/README.rst @@ -73,79 +73,22 @@ License ======= This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 -International License. To view a copy of this license, visit +International License (CC-BY-SA-4.0). To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. +Contributions are accepted under the same with sign-off under the Developer's +Certificate of Origin. For more on contributing to EBBR, see CONTRIBUTING.rst_.
A copy of the license is included in the LICENSE_ file. .. image:: https://i.creativecommons.org/l/by-sa/4.0/88x31.png :target: http://creativecommons.org/licenses/by-sa/4.0/ :alt: Creative Commons License +.. _CONTRIBUTING.rst: ./CONTRIBUTING.rst .. _LICENSE: ./LICENSE
-Contributing
-Master copy of this project is hosted on GitHub: -https://github.com/ARM-software/ebbr
-Anyone may contribute to the EBBR project. EBBR discussion uses the -boot-architecture_ and arm.ebbr-discuss mailing lists. -The 'official' list is arm.ebbr-discuss, but the list archives are not -yet public, so boot-architecture_ is being used to keep everything in -the open.
-* boot-architechture@lists.linaro.org -* arm.ebbr-discuss@arm.com
-Past discussions can be found in the boot-architecture-archive_.
-To help track the origin of contributions, this project uses the same -DCO_ "sign-off" process as used by the Linux kernel. -The sign-off is a simple line at the end of the explanation for the -patch, which certifies that you wrote it 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:
-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 Ihave the right to submit it under the open source licenseindicated in the file; or(b) The contribution is based upon previous work that, to the bestof my knowledge, is covered under an appropriate open sourcelicense and I have the right under that license to submit thatwork with modifications, whether created in whole or in partby me, under the same open source license (unless I ampermitted to submit under a different license), as indicatedin the file; or(c) The contribution was provided directly to me by some otherperson who certified (a), (b) or (c) and I have not modifiedit.(d) I understand and agree that this project and the contributionare public and that a record of the contribution (including allpersonal information I submit with it, including my sign-off) ismaintained indefinitely and may be redistributed consistent withthis project or the open source license(s) involved.-then you just add a line saying::
Signed-off-by: Random J Developer <random@developer.example.org>-IRC Channel: ``#ebbr`` on ofct
-.. _DCO: https://developercertificate.org/ -.. _boot-architecture: https://lists.linaro.org/mailman/listinfo/boot-architecture -.. _boot-architecture-archive: https://lists.linaro.org/pipermail/boot-architecture
Writers Guide
diff --git a/source/ebbr.rst b/source/ebbr.rst index 414e3af..4269b49 100644 --- a/source/ebbr.rst +++ b/source/ebbr.rst @@ -1,12 +1,12 @@ .. EBBR Source Document
- Copyright Arm Ltd. 2018
- Copyright Arm Limited, 2018 SPDX-License-Identifier: CC-BY-SA-4.0
#################################################### Embedded Base Boot Requirements (EBBR) Specification #################################################### -Copyright © 2017-2018 Arm Ltd and Contributors. +Copyright © 2017-2018 Arm Limited and Contributors. This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit -- 2.13.0
Arm.ebbr-discuss mailing list Arm.ebbr-discuss@arm.com
boot-architecture@lists.linaro.org
-
Daniel Thompson