1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK 2 3**************************************** 4Contributions and Additional Information 5**************************************** 6 7.. _resources-intro: 8 9Introduction 10============ 11 12The Yocto Project team is happy for people to experiment with the Yocto 13Project. There is a number of places where you can find help if you run into 14difficulties or find bugs. This presents information about contributing 15and participating in the Yocto Project. 16 17.. _resources-contributions: 18 19Contributions 20============= 21 22The Yocto Project gladly accepts contributions. You can submit changes 23to the project either by creating and sending pull requests, or by 24submitting patches through email. For information on how to do both as 25well as information on how to identify the maintainer for each area of 26code, see the :doc:`../contributor-guide/index`. 27 28.. _resources-bugtracker: 29 30Yocto Project Bugzilla 31====================== 32 33The Yocto Project uses its own implementation of 34:yocto_bugs:`Bugzilla <>` to track defects (bugs). 35Implementations of Bugzilla work well for group development because they 36track bugs and code changes, can be used to communicate changes and 37problems with developers, can be used to submit and review patches, and 38can be used to manage quality assurance. 39 40Sometimes it is helpful to submit, investigate, or track a bug against 41the Yocto Project itself (e.g. when discovering an issue with some 42component of the build system that acts contrary to the documentation or 43your expectations). 44 45For a general procedure and guidelines on how to use Bugzilla to submit a bug 46against the Yocto Project, see the following: 47 48- The ":doc:`../contributor-guide/report-defect`" 49 section in the Yocto Project and OpenEmbedded Contributor Guide. 50 51- The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` 52 53For information on Bugzilla in general, see https://www.bugzilla.org/about/. 54 55.. _resources-mailinglist: 56 57Mailing lists 58============= 59 60There are multiple mailing lists maintained by the Yocto Project as well 61as related OpenEmbedded mailing lists for discussion, patch submission 62and announcements. To subscribe to one of the following mailing lists, 63click on the appropriate URL in the following list and follow the 64instructions: 65 66- :yocto_lists:`/g/yocto` --- general Yocto Project 67 discussion mailing list. 68 69- :yocto_lists:`/g/yocto-patches` --- patch contribution mailing list for Yocto 70 Project-related layers which do not have their own mailing list. 71 72- :oe_lists:`/g/openembedded-core` --- discussion mailing 73 list about OpenEmbedded-Core (the core metadata). 74 75- :oe_lists:`/g/openembedded-devel` --- discussion 76 mailing list about OpenEmbedded. 77 78- :oe_lists:`/g/bitbake-devel` --- discussion mailing 79 list about the :term:`BitBake` build tool. 80 81- :yocto_lists:`/g/poky` --- discussion mailing list 82 about :term:`Poky`. 83 84- :yocto_lists:`/g/yocto-announce` --- mailing list to 85 receive official Yocto Project release and milestone announcements. 86 87- :yocto_lists:`/g/docs` --- discussion mailing list about the Yocto Project 88 documentation. 89 90See also :yocto_home:`the description of all mailing lists </community/mailing-lists/>`. 91 92.. _resources-irc: 93 94Internet Relay Chat (IRC) 95========================= 96 97Two IRC channels on `Libera Chat <https://libera.chat/>`__ 98are available for the Yocto Project and OpenEmbedded discussions: 99 100- ``#yocto`` 101 102- ``#oe`` 103 104.. _resources-links-and-related-documentation: 105 106Links and Related Documentation 107=============================== 108 109Here is a list of resources you might find helpful: 110 111- :yocto_home:`The Yocto Project Website <>`: The home site 112 for the Yocto Project. 113 114- :yocto_wiki:`The Yocto Project Main Wiki Page <>`: The main wiki page for 115 the Yocto Project. This page contains information about project 116 planning, release engineering, QA & automation, a reference site map, 117 and other resources related to the Yocto Project. 118 119- :oe_home:`OpenEmbedded <>`: The build system used by the 120 Yocto Project. This project is the upstream, generic, embedded 121 distribution from which the Yocto Project derives its build system 122 (Poky) and to which it contributes. 123 124- :oe_wiki:`BitBake </BitBake>`: The tool used to process metadata. 125 126- :doc:`BitBake User Manual <bitbake:index>`: A comprehensive 127 guide to the BitBake tool. If you want information on BitBake, see 128 this manual. 129 130- :doc:`/brief-yoctoprojectqs/index`: This 131 short document lets you experience building an image using the Yocto 132 Project without having to understand any concepts or details. 133 134- :doc:`/overview-manual/index`: This manual provides overview 135 and conceptual information about the Yocto Project. 136 137- :doc:`/dev-manual/index`: This manual is a "how-to" guide 138 that presents procedures useful to both application and system 139 developers who use the Yocto Project. 140 141- :doc:`/sdk-manual/index` manual: This 142 guide provides information that lets you get going with the standard 143 or extensible SDK. An SDK, with its cross-development toolchains, 144 allows you to develop projects inside or outside of the Yocto Project 145 environment. 146 147- :doc:`/bsp-guide/bsp`: This guide defines the structure 148 for BSP components. Having a commonly understood structure encourages 149 standardization. 150 151- :doc:`/kernel-dev/index`: This manual describes 152 how to work with Linux Yocto kernels as well as provides a bit of 153 conceptual information on the construction of the Yocto Linux kernel 154 tree. 155 156- :doc:`/ref-manual/index`: This 157 manual provides reference material such as variable, task, and class 158 descriptions. 159 160- :yocto_docs:`Yocto Project Mega-Manual </singleindex.html>`: This manual 161 is simply a single HTML file comprised of the bulk of the Yocto 162 Project manuals. It makes it easy to search for phrases and terms used 163 in the Yocto Project documentation set. 164 165- :doc:`/profile-manual/index`: This manual presents a set of 166 common and generally useful tracing and profiling schemes along with 167 their applications (as appropriate) to each tool. 168 169- :doc:`/toaster-manual/index`: This manual 170 introduces and describes how to set up and use Toaster. Toaster is an 171 Application Programming Interface (API) and web-based interface to 172 the :term:`OpenEmbedded Build System`, which uses 173 BitBake, that reports build information. 174 175- `Yocto Project BitBake extension for VSCode 176 <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__: 177 This extension provides a rich feature set when working with BitBake recipes 178 within the Visual Studio Code IDE. 179 180- :yocto_wiki:`FAQ </FAQ>`: A list of commonly asked 181 questions and their answers. 182 183- :doc:`Release Information </migration-guides/index>`: 184 Migration guides, release notes, new features, updates and known issues 185 for the current and past releases of the Yocto Project. 186 187- :yocto_bugs:`Bugzilla <>`: The bug tracking application 188 the Yocto Project uses. If you find problems with the Yocto Project, 189 you should report them using this application. 190 191- :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page 192 </Bugzilla_Configuration_and_Bug_Tracking>`: 193 Information on how to get set up and use the Yocto Project 194 implementation of Bugzilla for logging and tracking Yocto Project 195 defects. 196 197- Internet Relay Chat (IRC): Two IRC channels on 198 `Libera Chat <https://libera.chat/>`__ are 199 available for Yocto Project and OpenEmbeddded discussions: ``#yocto`` and 200 ``#oe``, respectively. 201 202- `Quick EMUlator (QEMU) <https://wiki.qemu.org/Index.html>`__: An 203 open-source machine emulator and virtualizer. 204