|
| 1 | +# Introduction to Open1722 Contribution Process |
| 2 | + |
| 3 | +There are two main methods to propose changes or extensions to Open1722: |
| 4 | + |
| 5 | +- If you have an idea or a question you can create an [issue](hhttps://github.com/COVESA/Open1722/issues) in GitHub. |
| 6 | +- If you already have prepared changes or extension that you think would be interesting for COVESA to include in Open1722 |
| 7 | + then you can create a [Pull Request (PR)](https://github.com/COVESA/Open1722/pulls). |
| 8 | + |
| 9 | +All contributions must follow the [COVESA contribution guidelines](https://covesa.global/contribute). |
| 10 | + |
| 11 | +## Creating a Pull Request towards Open1722 |
| 12 | + |
| 13 | +This is the typical workflow for preparing a pull request. A GitHub account is required. |
| 14 | + |
| 15 | +1. Create a personal or company fork of the [Open1722 repository](https://github.com/COVESA/Open1722) |
| 16 | +2. Clone the forked repository into your local development environment. |
| 17 | +3. Set up your local development environment, see [README.md](README.md) for some guidance. |
| 18 | +4. Create a local branch based on the Open1722 main branch to use for the proposed changes. |
| 19 | +5. Introduce the wanted changes or extensions in your local development environment, 6. Create a commit and upload to your own fork. |
| 20 | +7. In the GitHub UI, create a Pull Request from your fork to the main branch of [the Open1722 repository](https://github.com/COVESA/Open1722). |
| 21 | +8. Validate that automatic build checks for the PR succeed. |
| 22 | + |
| 23 | + |
| 24 | +## Guidelines and Recommendations |
| 25 | + |
| 26 | +This section includes general guidelines and recommendations for anyone interested in contributing to OPen1722. |
| 27 | + |
| 28 | +### All contributions must follow COVESA contribution guidelines |
| 29 | + |
| 30 | +COVESA has defined [contribution guidelines](https://covesa.global/contribute). |
| 31 | + |
| 32 | +Every contribution (commit) must carry the following sign-off line with your real name and email address: |
| 33 | + |
| 34 | +`Signed-off-by: Firstname Lastname <[email protected]>` |
| 35 | + |
| 36 | +By supplying this sign-off line, you indicate your acceptance of the COVESA Certificate of Origin. |
| 37 | + |
| 38 | +If using git command line you can add a sign-off by using the `-s` argument when creating a commit. |
| 39 | + |
| 40 | +For code files it is requested that a copyright and license statement is added as file header. |
| 41 | + |
| 42 | +This is the standard copyright header template for most Open1722 files |
| 43 | + |
| 44 | +``` |
| 45 | +/* |
| 46 | + * Copyright (c) 2024, COVESA |
| 47 | + * |
| 48 | + * Redistribution and use in source and binary forms, with or without |
| 49 | + * modification, are permitted provided that the following conditions are met: |
| 50 | + * |
| 51 | + * * Redistributions of source code must retain the above copyright notice, |
| 52 | + * this list of conditions and the following disclaimer. |
| 53 | + * * Redistributions in binary form must reproduce the above copyright |
| 54 | + * notice, this list of conditions and the following disclaimer in the |
| 55 | + * documentation and/or other materials provided with the distribution. |
| 56 | + * * Neither the name of COVESA nor the names of its contributors may be |
| 57 | + * used to endorse or promote products derived from this software without |
| 58 | + * specific prior written permission. |
| 59 | + * |
| 60 | + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 61 | + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 62 | + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| 63 | + * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE |
| 64 | + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 65 | + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
| 66 | + * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
| 67 | + * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| 68 | + * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 69 | + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 70 | + * |
| 71 | + * SPDX-License-Identifier: BSD-3-Clause |
| 72 | + */ |
| 73 | +``` |
| 74 | + |
| 75 | +Where {year} is the year the file was originally created. No need to update or append new years or a range of years later. |
| 76 | + |
| 77 | +### Additional licenses |
| 78 | + |
| 79 | +Not that _all_ Open1722 code is always available under BSD-3-Clause license. For some components - at the choice of the user - other _addtional_ licenses may apply. This is done to enable integration of Open1722 into ecosystems demanding other licenses. |
| 80 | + |
| 81 | +As an example for components related to Linux Kernel integration you might see |
| 82 | + |
| 83 | +``` |
| 84 | +SPDX-License-Identifier: BSD-3-Clause or GPL-2.0 |
| 85 | +``` |
| 86 | + |
| 87 | +When modifying a code file with such an extended license claim, your DCO confirms you are willing and able to release your provided contribution under either license mentioned in the SPDX-License-Identifier. |
0 commit comments