|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Want to contribute? Great! You can do so through the standard GitHub pull |
| 4 | +request model. For large contributions we do encourage you to file a ticket in |
| 5 | +the GitHub issues tracking system prior to any code development to coordinate |
| 6 | +with the DL-benchmarks development team early in the process. Coordinating up |
| 7 | +front helps to avoid frustration later on. Please follow the pattern used in |
| 8 | +the benchmarking files, e.g. defining a config class/struct containing |
| 9 | +benchmarking parameters, measuring performance for both training and |
| 10 | +inference, making sure every file contains licensing information, etc). |
| 11 | + |
| 12 | +Your contribution should be licensed under the MIT license, the license used |
| 13 | +by this project. If you want to also contribute code by others which is only |
| 14 | +available under a different open source license, make sure that the license is |
| 15 | +compatible with this project's license and that the file |
| 16 | +[3rd-party-licenses.txt] (3rd-party-licenses.txt) is updated accordingly. |
| 17 | + |
| 18 | +## Sign your work |
| 19 | + |
| 20 | +This project tracks patch provenance and licensing using the Developer |
| 21 | +Certificate of Origin (from [developercertificate.org][DCO]) and Signed-off-by |
| 22 | +tags initially developed by the Linux kernel project. |
| 23 | + |
| 24 | +``` |
| 25 | +Developer Certificate of Origin |
| 26 | +Version 1.1 |
| 27 | +
|
| 28 | +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. |
| 29 | +660 York Street, Suite 102, |
| 30 | +San Francisco, CA 94110 USA |
| 31 | +
|
| 32 | +Everyone is permitted to copy and distribute verbatim copies of this |
| 33 | +license document, but changing it is not allowed. |
| 34 | +
|
| 35 | +Developer's Certificate of Origin 1.1 |
| 36 | +
|
| 37 | +By making a contribution to this project, I certify that: |
| 38 | +
|
| 39 | +(a) The contribution was created in whole or in part by me and I |
| 40 | + have the right to submit it under the open source license |
| 41 | + indicated in the file; or |
| 42 | +
|
| 43 | +(b) The contribution is based upon previous work that, to the best |
| 44 | + of my knowledge, is covered under an appropriate open source |
| 45 | + license and I have the right under that license to submit that |
| 46 | + work with modifications, whether created in whole or in part |
| 47 | + by me, under the same open source license (unless I am |
| 48 | + permitted to submit under a different license), as indicated |
| 49 | + in the file; or |
| 50 | +
|
| 51 | +(c) The contribution was provided directly to me by some other |
| 52 | + person who certified (a), (b) or (c) and I have not modified |
| 53 | + it. |
| 54 | +
|
| 55 | +(d) I understand and agree that this project and the contribution |
| 56 | + are public and that a record of the contribution (including all |
| 57 | + personal information I submit with it, including my sign-off) is |
| 58 | + maintained indefinitely and may be redistributed consistent with |
| 59 | + this project or the open source license(s) involved. |
| 60 | +``` |
| 61 | + |
| 62 | +With the sign-off in a commit message you certify that you authored the patch |
| 63 | +or otherwise have the right to submit it under an open source license. The |
| 64 | +procedure is simple: To certify above Developer's Certificate of Origin 1.1 |
| 65 | +for your contribution just append a line |
| 66 | + |
| 67 | + Signed-off-by: Random J Developer <random@developer.example.org> |
| 68 | + |
| 69 | +to every commit message using your real name (sorry, no pseudonyms or |
| 70 | +anonymous contributions). If you have set your `user.name` and `user.email` |
| 71 | +git configs you can automatically sign the commit by running the git-commit |
| 72 | +command with the -s option. There may be multiple sign-offs if more than one |
| 73 | +developer was involved in authoring the contribution. |
| 74 | + |
| 75 | +For a more detailed description of this procedure, please see |
| 76 | +[SubmittingPatches][] which was extracted from the Linux kernel project, and |
| 77 | +which is stored in an external repository. |
| 78 | + |
| 79 | +[DCO]: http://developercertificate.org/ |
| 80 | +[SubmittingPatches]: https://github.com/wking/signed-off-by/blob/7d71be37194df05c349157a2161c7534feaf86a4/Documentation/SubmittingPatches |
0 commit comments