summaryrefslogtreecommitdiffstats
path: root/documentation/contributor-guide/identify-component.rst
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-08-02 16:01:13 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-08-30 15:54:59 +0100
commit8a11abf6a9dac76bf9739c44102a49984e3c2977 (patch)
treee9fad45beb65d1330dad49408de14cd164820bd4 /documentation/contributor-guide/identify-component.rst
parentddf3b3ecd4b1680dc0dedfd4eaebcf3441b14ca7 (diff)
downloadpoky-8a11abf6a9dac76bf9739c44102a49984e3c2977.tar.gz
manuals: create a dedicated "Contributor Guide" document
Starting from the original contents of dev-manual/changes.rst and from text contributed by Richard Purdie. (From yocto-docs rev: 55587d9dd009cbc92273376e0f7665b2d574d280) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/contributor-guide/identify-component.rst')
-rw-r--r--documentation/contributor-guide/identify-component.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/documentation/contributor-guide/identify-component.rst b/documentation/contributor-guide/identify-component.rst
new file mode 100644
index 0000000000..ba7c998888
--- /dev/null
+++ b/documentation/contributor-guide/identify-component.rst
@@ -0,0 +1,29 @@
1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2
3Identify the component
4**********************
5
6The Yocto Project and OpenEmbedded ecosystem is built of :term:`layers <Layer>`
7so the first step is to identify the component where the issue likely lies.
8For example, if you have a hardware issue, it is likely related to the BSP
9you are using and the best place to seek advice would be from the BSP provider
10or :term:`layer`. If the issue is a build/configuration one and a distro is in
11use, they would likely be the first place to ask questions. If the issue is a
12generic one and/or in the core classes or metadata, the core layer or BitBake
13might be the appropriate component.
14
15Each metadata layer being used should contain a ``README`` file and that should
16explain where to report issues, where to send changes and how to contact the
17maintainers.
18
19If the issue is in the core metadata layer (OpenEmbedded-Core) or in BitBake,
20issues can be reported in the :yocto_bugs:`Yocto Project Bugzilla <>`. The
21:yocto_lists:`yocto </g/yocto>` mailing list is a general “catch-all” location
22where questions can be sent if you can’t work out where something should go.
23
24:term:`Poky` is a commonly used “combination” repository where multiple
25components have been combined (``bitbake``, ``openembedded-core``,
26``meta-yocto`` and ``yocto-docs``). Patches should be submitted against
27the appropriate individual component rather than :term:`Poky` itself as
28detailed in the appropriate ``README`` file.
29