Skip to content

Commit

Permalink
Move contributing details to CONTRIBUTING file
Browse files Browse the repository at this point in the history
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 <[email protected]>
Signed-off-by: Grant Likely <[email protected]>
Reviewed-by: Alexander Graf <[email protected]>
Reviewed-by: Daniel Thompson <[email protected]>
  • Loading branch information
glikely committed May 17, 2018
1 parent ac8295f commit 9edb47c
Show file tree
Hide file tree
Showing 4 changed files with 78 additions and 65 deletions.
70 changes: 70 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -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.

* [email protected]
* [email protected]

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 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 saying::

Signed-off-by: Random J Developer <[email protected]>

.. _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

2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
67 changes: 5 additions & 62 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

* [email protected]
* [email protected]

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 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 saying::

Signed-off-by: Random J Developer <[email protected]>

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
=============

Expand Down
4 changes: 2 additions & 2 deletions source/ebbr.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 9edb47c

Please sign in to comment.