blob: 4abeb9ff0e4d706c88fb27e907bd3ee417af9786 [file] [log] [blame]
David B. Kinder2d4728d2017-07-27 17:04:04 -07001Contribution Guidelines
2#######################
3
4As an open-source project, we welcome and encourage the community to submit
5patches directly to the project. In our collaborative open source environment,
6standards and methods for submitting changes help reduce the chaos that can result
7from an active development community.
8
David B. Kinderf6349c82018-07-26 16:08:14 -07009This document briefly summarizes the full `Contribution
Tim Sørensen (TIMS)ed80be52019-02-28 16:44:53 +010010Guidelines <http://docs.zephyrproject.org/latest/contribute/index.html>`_
David B. Kinderf6349c82018-07-26 16:08:14 -070011documentation.
David B. Kinder2d4728d2017-07-27 17:04:04 -070012
David B. Kinderf6349c82018-07-26 16:08:14 -070013* 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. Kinder2d4728d2017-07-27 17:04:04 -070016
David B. Kinderf6349c82018-07-26 16:08:14 -070017* There are some imported or reused components of the Zephyr project that
18 use other licensing and are clearly identified.
David B. Kinder2d4728d2017-07-27 17:04:04 -070019
David B. Kinderf6349c82018-07-26 16:08:14 -070020* The Developer Certificate of Origin (DCO) process is followed to
David B. Kinder1d1a4b32018-08-28 09:36:14 -070021 ensure developers are following licensing criteria for their
Himanshu Jhafad97ef2018-10-25 12:38:45 +053022 contributions, and documented with a ``Signed-off-by`` line in commits.
David B. Kinder2d4728d2017-07-27 17:04:04 -070023
David B. Kinderf6349c82018-07-26 16:08:14 -070024* Zephyr development workflow is supported on Linux, macOS, and Windows,
David B. Kinder1d1a4b32018-08-28 09:36:14 -070025 (with a few exceptions).
David B. Kinder2d4728d2017-07-27 17:04:04 -070026
David B. Kinderf6349c82018-07-26 16:08:14 -070027* Source code for the project is maintained in the GitHub repo:
28 https://github.com/zephyrproject-rtos/zephyr
David B. Kinder2d4728d2017-07-27 17:04:04 -070029
David B. Kinderf6349c82018-07-26 16:08:14 -070030* Issue and feature tracking is done using GitHub issues in this repo.
David B. Kinder2d4728d2017-07-27 17:04:04 -070031
David B. Kinderf6349c82018-07-26 16:08:14 -070032* 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. Kinder10b24a82017-09-19 17:23:35 -070035
David B. Kinderf6349c82018-07-26 16:08:14 -070036* 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. Kinder2d4728d2017-07-27 17:04:04 -070038
David B. Kindera380dce2018-04-16 10:04:28 -070039.. _Zephyr devel mailing list: https://lists.zephyrproject.org/g/devel