2017-07-28 08:04:04 +08:00
|
|
|
Contribution Guidelines
|
|
|
|
|
#######################
|
|
|
|
|
|
|
|
|
|
As an open-source project, we welcome and encourage the community to submit
|
|
|
|
|
patches directly to the project. In our collaborative open source environment,
|
|
|
|
|
standards and methods for submitting changes help reduce the chaos that can result
|
|
|
|
|
from an active development community.
|
|
|
|
|
|
2018-07-27 07:08:14 +08:00
|
|
|
This document briefly summarizes the full `Contribution
|
2018-09-12 21:25:28 +08:00
|
|
|
Guidelines <http://docs.zephyrproject.org/latest/contribute/contribute.html>`_
|
2018-07-27 07:08:14 +08:00
|
|
|
documentation.
|
2017-07-28 08:04:04 +08:00
|
|
|
|
2018-07-27 07:08:14 +08:00
|
|
|
* Zephyr uses the permissive open source `Apache 2.0 license`_
|
|
|
|
|
that allows you to freely use, modify, distribute and sell your own products
|
|
|
|
|
that include Apache 2.0 licensed software.
|
2017-07-28 08:04:04 +08:00
|
|
|
|
2018-07-27 07:08:14 +08:00
|
|
|
* There are some imported or reused components of the Zephyr project that
|
|
|
|
|
use other licensing and are clearly identified.
|
2017-07-28 08:04:04 +08:00
|
|
|
|
2018-07-27 07:08:14 +08:00
|
|
|
* The Developer Certificate of Origin (DCO) process is followed to
|
2018-08-29 00:36:14 +08:00
|
|
|
ensure developers are following licensing criteria for their
|
2018-10-25 15:08:45 +08:00
|
|
|
contributions, and documented with a ``Signed-off-by`` line in commits.
|
2017-07-28 08:04:04 +08:00
|
|
|
|
2018-07-27 07:08:14 +08:00
|
|
|
* Zephyr development workflow is supported on Linux, macOS, and Windows,
|
2018-08-29 00:36:14 +08:00
|
|
|
(with a few exceptions).
|
2017-07-28 08:04:04 +08:00
|
|
|
|
2018-07-27 07:08:14 +08:00
|
|
|
* Source code for the project is maintained in the GitHub repo:
|
|
|
|
|
https://github.com/zephyrproject-rtos/zephyr
|
2017-09-20 08:23:35 +08:00
|
|
|
|
2018-07-27 07:08:14 +08:00
|
|
|
* Issue and feature tracking is done using GitHub issues in this repo.
|
2017-09-20 08:23:35 +08:00
|
|
|
|
2018-07-27 07:08:14 +08:00
|
|
|
* A Continuous Integration (CI) system runs on every Pull Request (PR)
|
|
|
|
|
to verify several aspects of the PR including Git commit formatting,
|
|
|
|
|
Coding Style, sanity checks builds, and documentation builds.
|
2017-09-20 08:23:35 +08:00
|
|
|
|
2018-07-27 07:08:14 +08:00
|
|
|
* The `Zephyr devel mailing list`_ is a great place to engage with the
|
|
|
|
|
community, ask questions, discuss issues, and help each other.
|
2017-07-28 08:04:04 +08:00
|
|
|
|
2018-04-17 01:04:28 +08:00
|
|
|
.. _Zephyr devel mailing list: https://lists.zephyrproject.org/g/devel
|
