|
| 1 | +<!-- |
| 2 | +# Copyright (c) 2018, NVIDIA CORPORATION. All rights reserved. |
| 3 | +# |
| 4 | +# Redistribution and use in source and binary forms, with or without |
| 5 | +# modification, are permitted provided that the following conditions |
| 6 | +# are met: |
| 7 | +# * Redistributions of source code must retain the above copyright |
| 8 | +# notice, this list of conditions and the following disclaimer. |
| 9 | +# * Redistributions in binary form must reproduce the above copyright |
| 10 | +# notice, this list of conditions and the following disclaimer in the |
| 11 | +# documentation and/or other materials provided with the distribution. |
| 12 | +# * Neither the name of NVIDIA CORPORATION nor the names of its |
| 13 | +# contributors may be used to endorse or promote products derived |
| 14 | +# from this software without specific prior written permission. |
| 15 | +# |
| 16 | +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY |
| 17 | +# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 18 | +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
| 19 | +# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
| 20 | +# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| 21 | +# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
| 22 | +# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
| 23 | +# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY |
| 24 | +# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 25 | +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 26 | +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 27 | +--> |
| 28 | + |
| 29 | +# Contribution Rules |
| 30 | + |
| 31 | +- While we have not yet documented a strict code style convention, |
| 32 | + please follow the existing conventions in the relevant file, |
| 33 | + submodule, module, and project when you add new code or when you |
| 34 | + extend/fix existing functionality. |
| 35 | + |
| 36 | +- Avoid introducing unnecessary complexity into existing code so that |
| 37 | + maintainability and readability are preserved. |
| 38 | + |
| 39 | +- Try to keep pull requests (PRs) as concise as possible: |
| 40 | + |
| 41 | + - Avoid committing commented-out code. |
| 42 | + |
| 43 | + - Wherever possible, each PR should address a single concern. If |
| 44 | + there are several otherwise-unrelated things that should be fixed |
| 45 | + to reach a desired endpoint, it is perfectly fine to open several |
| 46 | + PRs and state in the description which PR depends on another |
| 47 | + PR. The more complex the changes are in a single PR, the more time |
| 48 | + it will take to review those changes. |
| 49 | + |
| 50 | + - Make sure that the build log is clean, meaning no warnings or |
| 51 | + errors should be present. |
| 52 | + |
| 53 | +- Make sure all `L0_*` tests pass: |
| 54 | + |
| 55 | + - In the `qa/` directory, there are basic sanity tests scripted in |
| 56 | + directories named `L0_...`. See the Testing section in the |
| 57 | + Developer Guide for instructions on running these tests. |
| 58 | + |
| 59 | +- TensorRT Inference Server's default build assumes recent versions of |
| 60 | + dependencies (CUDA, TensorFlow, PyTorch, TensorRT, |
| 61 | + etc.). Contributions that add compatibility with older versions of |
| 62 | + those dependencies will be considered, but NVIDIA cannot guarantee |
| 63 | + that all possible build configurations work, are not broken by |
| 64 | + future contributions, and retain highest performance. |
| 65 | + |
| 66 | +- Make sure that you can contribute your work to open source (no |
| 67 | + license and/or patent conflict is introduced by your code). You need |
| 68 | + to [`sign`](#Sign) your commit. |
| 69 | + |
| 70 | +- Thanks in advance for your patience as we review your contributions; |
| 71 | + we do appreciate them! |
| 72 | + |
| 73 | +<a name="Sign"></a>Sign Your Work |
| 74 | +-------------- |
| 75 | + |
| 76 | +We require that all contributors "sign-off" on their commits. This |
| 77 | +certifies that the contribution is your original work, or you have |
| 78 | +rights to submit it under the same license, or a compatible license. |
| 79 | + |
| 80 | +Any contribution which contains commits that are not Signed-Off will |
| 81 | +not be accepted. |
| 82 | + |
| 83 | +To sign off on a commit you simply use the `--signoff` (or `-s`) |
| 84 | +option when committing your changes: |
| 85 | + |
| 86 | + $ git commit -s -m "Add cool feature." |
| 87 | + |
| 88 | +This will append the following to your commit message: |
| 89 | + |
| 90 | + Signed-off-by: Your Name <[email protected]> |
| 91 | + |
| 92 | +By doing this you certify the below: |
| 93 | + |
| 94 | + Developer Certificate of Origin |
| 95 | + Version 1.1 |
| 96 | + |
| 97 | + Copyright (C) 2004, 2006 The Linux Foundation and its contributors. |
| 98 | + 1 Letterman Drive |
| 99 | + Suite D4700 |
| 100 | + San Francisco, CA, 94129 |
| 101 | + |
| 102 | + Everyone is permitted to copy and distribute verbatim copies of |
| 103 | + this license document, but changing it is not allowed. |
| 104 | + |
| 105 | + |
| 106 | + Developer's Certificate of Origin 1.1 |
| 107 | + |
| 108 | + By making a contribution to this project, I certify that: |
| 109 | + |
| 110 | + (a) The contribution was created in whole or in part by me and I |
| 111 | + have the right to submit it under the open source license |
| 112 | + indicated in the file; or |
| 113 | + |
| 114 | + (b) The contribution is based upon previous work that, to the best |
| 115 | + of my knowledge, is covered under an appropriate open source |
| 116 | + license and I have the right under that license to submit that |
| 117 | + work with modifications, whether created in whole or in part by |
| 118 | + me, under the same open source license (unless I am permitted to |
| 119 | + submit under a different license), as indicated in the file; or |
| 120 | + |
| 121 | + (c) The contribution was provided directly to me by some other |
| 122 | + person who certified (a), (b) or (c) and I have not modified it. |
| 123 | + |
| 124 | + (d) I understand and agree that this project and the contribution |
| 125 | + are public and that a record of the contribution (including all |
| 126 | + personal information I submit with it, including my sign-off) is |
| 127 | + maintained indefinitely and may be redistributed consistent with |
| 128 | + this project or the open source license(s) involved. |
0 commit comments