David B. Kinder | 2d4728d | 2017-07-27 17:04:04 -0700 | [diff] [blame] | 1 | Contribution Guidelines |
| 2 | ####################### |
| 3 | |
| 4 | As an open-source project, we welcome and encourage the community to submit |
| 5 | patches directly to the project. In our collaborative open source environment, |
| 6 | standards and methods for submitting changes help reduce the chaos that can result |
| 7 | from an active development community. |
| 8 | |
David B. Kinder | f6349c8 | 2018-07-26 16:08:14 -0700 | [diff] [blame] | 9 | This document briefly summarizes the full `Contribution |
Tim Sørensen (TIMS) | ed80be5 | 2019-02-28 16:44:53 +0100 | [diff] [blame] | 10 | Guidelines <http://docs.zephyrproject.org/latest/contribute/index.html>`_ |
David B. Kinder | f6349c8 | 2018-07-26 16:08:14 -0700 | [diff] [blame] | 11 | documentation. |
David B. Kinder | 2d4728d | 2017-07-27 17:04:04 -0700 | [diff] [blame] | 12 | |
David B. Kinder | f6349c8 | 2018-07-26 16:08:14 -0700 | [diff] [blame] | 13 | * Zephyr uses the permissive open source `Apache 2.0 license`_ |
| 14 | that allows you to freely use, modify, distribute and sell your own products |
| 15 | that include Apache 2.0 licensed software. |
David B. Kinder | 2d4728d | 2017-07-27 17:04:04 -0700 | [diff] [blame] | 16 | |
David B. Kinder | f6349c8 | 2018-07-26 16:08:14 -0700 | [diff] [blame] | 17 | * There are some imported or reused components of the Zephyr project that |
| 18 | use other licensing and are clearly identified. |
David B. Kinder | 2d4728d | 2017-07-27 17:04:04 -0700 | [diff] [blame] | 19 | |
David B. Kinder | f6349c8 | 2018-07-26 16:08:14 -0700 | [diff] [blame] | 20 | * The Developer Certificate of Origin (DCO) process is followed to |
David B. Kinder | 1d1a4b3 | 2018-08-28 09:36:14 -0700 | [diff] [blame] | 21 | ensure developers are following licensing criteria for their |
Himanshu Jha | fad97ef | 2018-10-25 12:38:45 +0530 | [diff] [blame] | 22 | contributions, and documented with a ``Signed-off-by`` line in commits. |
David B. Kinder | 2d4728d | 2017-07-27 17:04:04 -0700 | [diff] [blame] | 23 | |
David B. Kinder | f6349c8 | 2018-07-26 16:08:14 -0700 | [diff] [blame] | 24 | * Zephyr development workflow is supported on Linux, macOS, and Windows, |
David B. Kinder | 1d1a4b3 | 2018-08-28 09:36:14 -0700 | [diff] [blame] | 25 | (with a few exceptions). |
David B. Kinder | 2d4728d | 2017-07-27 17:04:04 -0700 | [diff] [blame] | 26 | |
David B. Kinder | f6349c8 | 2018-07-26 16:08:14 -0700 | [diff] [blame] | 27 | * Source code for the project is maintained in the GitHub repo: |
| 28 | https://github.com/zephyrproject-rtos/zephyr |
David B. Kinder | 2d4728d | 2017-07-27 17:04:04 -0700 | [diff] [blame] | 29 | |
David B. Kinder | f6349c8 | 2018-07-26 16:08:14 -0700 | [diff] [blame] | 30 | * Issue and feature tracking is done using GitHub issues in this repo. |
David B. Kinder | 2d4728d | 2017-07-27 17:04:04 -0700 | [diff] [blame] | 31 | |
David B. Kinder | f6349c8 | 2018-07-26 16:08:14 -0700 | [diff] [blame] | 32 | * A Continuous Integration (CI) system runs on every Pull Request (PR) |
| 33 | to verify several aspects of the PR including Git commit formatting, |
| 34 | Coding Style, sanity checks builds, and documentation builds. |
David B. Kinder | 10b24a8 | 2017-09-19 17:23:35 -0700 | [diff] [blame] | 35 | |
David B. Kinder | f6349c8 | 2018-07-26 16:08:14 -0700 | [diff] [blame] | 36 | * The `Zephyr devel mailing list`_ is a great place to engage with the |
| 37 | community, ask questions, discuss issues, and help each other. |
David B. Kinder | 2d4728d | 2017-07-27 17:04:04 -0700 | [diff] [blame] | 38 | |
David B. Kinder | a380dce | 2018-04-16 10:04:28 -0700 | [diff] [blame] | 39 | .. _Zephyr devel mailing list: https://lists.zephyrproject.org/g/devel |