Skip to content

Commit e02de5e

Browse files
authored
update README (#14)
Signed-off-by: Robert Cohn <[email protected]>
1 parent 8af1b6e commit e02de5e

File tree

2 files changed

+93
-0
lines changed

2 files changed

+93
-0
lines changed

CONTRIBUTING.rst

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
==============
2+
Contributing
3+
==============
4+
5+
We welcome community contributions. You can:
6+
7+
* Submit your changes directly with a pull request
8+
* Log a bug or feedback with an issue
9+
10+
Pull requests
11+
=============
12+
13+
This project follows the GitHub flow. Make sure your change is in line
14+
with our coding conventions. Submit a pull request to the master
15+
branch.
16+
17+
License
18+
=======
19+
20+
See licenses_ for license information. By contributing to the
21+
project, you agree to the license and copyright terms therein and
22+
release your contribution under these terms.
23+
24+
Sign your work
25+
==============
26+
27+
Please use the sign-off line at the end of the patch. Your signature
28+
certifies that you wrote the patch or otherwise have the right to pass
29+
it on as an open-source patch. The rules are pretty simple: if you can
30+
certify `Linux Foundation Developer Certification of Origin`_ below::
31+
32+
Developer Certificate of Origin Version 1.1
33+
34+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
35+
660 York Street, Suite 102,
36+
San Francisco, CA 94110 USA
37+
38+
Everyone is permitted to copy and distribute verbatim copies of this
39+
license document, but changing it is not allowed.
40+
41+
Developer's Certificate of Origin 1.1
42+
43+
By making a contribution to this project, I certify that:
44+
45+
(a) The contribution was created in whole or in part by me and I
46+
have the right to submit it under the open source license
47+
indicated in the file; or
48+
49+
(b) The contribution is based upon previous work that, to the best
50+
of my knowledge, is covered under an appropriate open source
51+
license and I have the right under that license to submit that
52+
work with modifications, whether created in whole or in part by
53+
me, under the same open source license (unless I am permitted to
54+
submit under a different license), as indicated in the file; or
55+
56+
(c) The contribution was provided directly to me by some other
57+
person who certified (a), (b) or (c) and I have not modified it.
58+
59+
(d) I understand and agree that this project and the contribution
60+
are public and that a record of the contribution (including all
61+
personal information I submit with it, including my sign-off) is
62+
maintained indefinitely and may be redistributed consistent with
63+
this project or the open source license(s) involved.
64+
65+
Then you just add a line to every git commit message::
66+
67+
Signed-off-by: Joe Smith <[email protected]>
68+
69+
Use your real name (sorry, no pseudonyms or anonymous contributions.)
70+
If you set your user.name and user.email git configs, you can sign your
71+
commit automatically with git commit -s.
72+
73+
.. _licenses: LICENSES
74+
.. _`Linux Foundation Developer Certification of Origin`: https://developercertificate.org/

README.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,25 @@ issues. Replace calls to "install" scripts with calls to
6464
"install_debug" or "install_debug_hang" scripts to use this
6565
functionality.
6666

67+
License
68+
=======
69+
70+
See licenses_
71+
72+
Contribute
73+
==========
74+
75+
See contributing_.
76+
77+
Security
78+
========
79+
80+
See `security guidelines`_.
81+
82+
.. _licenses: LICENSES
83+
.. _contributing: CONTRIBUTING.rst
84+
.. _`security guidelines`: https://www.intel.com/content/www/us/en/security-center/default.html
85+
6786
.. _`.travis.yml`: .travis.yml
6887
.. _`.circleci/config.yml`: .circleci/config.yml
6988
.. _`.appveyor.yml`: .appveyor.yml

0 commit comments

Comments
 (0)