Lines Matching +full:modules +full:- +full:start +full:- +full:from +full:- +full:bottom
6 As an open-source project, we welcome and encourage the community to submit
9 from an active development community.
52 https://github.com/zephyrproject-rtos/zephyr/blob/main/LICENSE
54 .. _GitHub repo: https://github.com/zephyrproject-rtos/zephyr
66 https://www.zephyrproject.org/faqs/#1571346989065-9216c551-f523
69 https://www.whitesourcesoftware.com/whitesource-blog/top-10-apache-license-questions-answered/
83 Importing code into the Zephyr OS from other projects that use a license
92 See :ref:`external-contributions` for more information about
107 The Zephyr Project follows the `Community Best Practice`_ for Copyright Notices from the Linux
112 .. code-block:: C
117 https://www.linuxfoundation.org/blog/copyright-notices-in-open-source-software-projects/
130 later in this document), the developer simply adds a ``Signed-off-by``
137 .. code-block:: none
162 sign-off) is maintained indefinitely and may be redistributed
166 DCO Sign-Off
169 The "sign-off" in the DCO is a "Signed-off-by:" line in each commit's log
170 message. The Signed-off-by: line must be in the following format::
172 Signed-off-by: Your Name <your.email@example.com>
176 - ``Your Name`` with your legal name (pseudonyms, hacker handles, and the
179 - ``your.email@example.com`` with the same email address you are using to
182 You can automatically add the Signed-off-by: line to your commit body using
183 ``git commit -s``. Use other commits in the zephyr git history as examples.
189 - If you are altering an existing commit created by someone else, you must add
190 your Signed-off-by: line without removing the existing one.
211 The top-level file for the CMake build system, containing a lot of the
215 The top-level Kconfig file, which refers to the file :file:`Kconfig.zephyr`
216 also found in the top-level directory.
223 the west command-line tool.
225 The Zephyr source tree also contains the following top-level
230 Architecture-specific kernel and system-on-chip (SoC) code.
235 * architecture-specific kernel source files
236 * architecture-specific kernel include files for private APIs
252 :ref:`devicetree <dt-guide>` source files used to describe non-discoverable
253 board-specific hardware details.
259 Architecture-independent kernel code.
265 Miscellaneous code that doesn't belong to any of the other top-level
296 .. _Zephyr Project Issues: https://github.com/zephyrproject-rtos/zephyr/issues
298 .. _open pull requests: https://github.com/zephyrproject-rtos/zephyr/pulls
334 .. code-block:: console
336 git config --global user.name "Zephyr Developer"
337 git config --global user.email "z.developer@example.com"
358 .. _commit-guidelines:
367 .. code-block:: none
371 [Commit message body (must be non-empty)]
373 Signed-off-by: [Your Full Name] <[your.email@address]>
380 .. code-block:: none
385 the response packet from the device which signals that an error
386 occurred. This can lead to reading invalid data from the response
389 Signed-off-by: Zephyr Developer <z.developer@example.com>
392 ---------------------------
410 * ``net: ethernet:`` for Ethernet-related networking changes
426 -------------------
441 * **how** you know it works -- for example, which tests you ran.
448 `changelog <https://github.com/zephyrproject-rtos/zephyr/commits/main>`__.
451 Signed-off-by: ...
452 ------------------
457 already. Create your commit with ``git commit -s`` to add the
458 Signed-off-by: line automatically using this information.
461 Signed-off-by: line that looks like this:
463 .. code-block:: none
465 Signed-off-by: [Your Full Name] <[your.email@address]>
470 .. code-block:: none
472 Signed-off-by: Zephyr Developer <z.developer@example.com>
481 See the :ref:`contributor-expectations` for a more complete discussion of
485 ------------
488 …https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolink…
495 .. code-block:: none
502 .. code-block:: none
510 .. code-block:: none
512 Link: https://github.com/zephyrproject-rtos/zephyr/issues/<issue number>
532 The current status of the CI run can always be found at the bottom of the
545 non-green) build.
555 -------------------
565 .. code-block:: bash
567 ./scripts/ci/check_compliance.py -c upstream/main..
577 -------
586 If a test fails, you can check from the CI run logs how to rerun it locally,
589 .. code-block:: bash
591 west twister -p native_sim -s tests/drivers/build_all/sensor/sensors.generic_test
614 results you have to create an account yourself. From the Zephyr project page,
618 Static analysis of the Zephyr codebase is conducted on a bi-weekly basis. GitHub
663 https://github.com/zephyrproject-rtos/zephyr#fork-destination-box
675 <https://github.com/zephyrproject-rtos/zephyr>`_ from ``origin`` to
686 git remote -v
692 upstream https://github.com/zephyrproject-rtos/zephyr (fetch)
693 upstream https://github.com/zephyrproject-rtos/zephyr (push)
699 git checkout -b fix_comment_typo
701 Some Zephyr subsystems do development work on a separate branch from
704 git checkout -b fix_out_of_date_patch origin/net
709 #. When things look good, start the pull request process by adding your changed
712 git add [file(s) that changed, add -p if you want to be more specific]
720 git diff --cached
724 git commit -s
726 The ``-s`` option automatically adds your ``Signed-off-by:`` to your commit
728 agreement with the :ref:`DCO`. See the :ref:`commit-guidelines` section for
741 request for the ``main`` branch. The title and message from your commit
750 on your pull request at https://github.com/zephyrproject-rtos/zephyr/pulls.
757 git checkout -b fix_another_issue
764 git rebase -i <offending-commit-id>^
775 git rebase --continue
779 git push --force origin fix_comment_typo
787 git fetch --all
788 git rebase --ignore-whitespace upstream/main
790 The ``--ignore-whitespace`` option stops ``git apply`` (called by rebase)
791 from changing any whitespace. Resolve the conflicts and push again::
793 git push --force origin fix_comment_typo
799 one - GitHub complains it can't find older commits. You're also not
818 .. _git-rebase:
819 https://git-scm.com/docs/git-rebase#Documentation/git-rebase.txt---keep-base
821 #. When pushing follow-up changes, use the ``--keep-base`` option of
822 `git-rebase`_
837 #. Revisit PR after 1-2 hours to see the status of all CI checks, make sure all
841 sure you click the "Re-request review" button on the GitHub UI to notify
855 In cases where the file is :ref:`imported from an external project
856 <external-contributions>`, the commit message shall contain details regarding
857 the original project, the location of the project, the SHA-id of the origin
863 License: BSD 3-Clause
864 URL: http://www.contiki-os.org/
871 License: BSD 3-Clause
876 Contributions to External Modules
879 Follow the guidelines in the :ref:`modules` section for contributing
880 :ref:`new modules <submitting_new_modules>` and
881 submitting changes to :ref:`existing modules <changes_to_existing_module>`.
883 .. _treewide-changes:
899 do so for a wide class of external Zephyr-based source code.
913 - The zephyr repository must apply the 'treewide' GitHub label to any issues or
916 - The person proposing a treewide change must create an `RFC issue
917 …<https://github.com/zephyrproject-rtos/zephyr/issues/new?assignees=&labels=RFC&template=003_rfc-pr…
921 - The project's `Architecture Working Group (WG)
922 <https://github.com/zephyrproject-rtos/zephyr/wiki/Architecture-Working-Group>`_
928 - The Architecture WG must specify the procedure for merging any PRs associated
932 - The person proposing a treewide change must email
941 - the deprecation of version 1 of the :ref:`Logging API <logging_api>` in favor
943 <https://github.com/zephyrproject-rtos/zephyr/commit/262cc55609b73ea61b5f999c6c6daaba20bc5240>`_)
944 - the removal of support for a legacy :ref:`dt-bindings` syntax
946 <https://github.com/zephyrproject-rtos/zephyr/commit/6bf761fc0a2811b037abec0c963d60b00c452acb>`_)
956 whenever possible so that the device can be used with any SoC from any vendor
965 from.