Skip to contentSkip to conversation

manuals: create a dedicated "Contributor Guide" document

PATCH New [email protected] 1 participant 1 message Aug 2, 2023

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 manuals: create a dedicated "Contributor Guide" document

From: Michael Opdenacker <[email protected]>

Starting from the original contents of dev-manual/changes.rst and from text contributed by Richard Purdie.

---

The content will evolve according to existing content on the OE and Yocto wikis and on new content provided by contributors. This initiative is supported by the YP TSC.

---
 documentation/bsp-guide/bsp.rst               |   4 +-
 .../contributor-guide/identify-component.rst  |  29 +++++
 documentation/contributor-guide/index.rst     |  25 +++++
 .../submit-change.rst}                        | 102 ++++--------------
 .../contributor-guide/submit-defect.rst       |  67 ++++++++++++
 documentation/dev-manual/debugging.rst        |   7 +-
 documentation/dev-manual/index.rst            |   3 -
 documentation/dev-manual/start.rst            |   9 +-
 documentation/dev-manual/vulnerabilities.rst  |   2 +-
 documentation/index.rst                       |   1 +
 .../development-environment.rst               |  19 ++--
 documentation/ref-manual/resources.rst        |   7 +-
 .../ref-manual/system-requirements.rst        |   4 +-
 13 files changed, 165 insertions(+), 114 deletions(-)
 create mode 100644 documentation/contributor-guide/identify-component.rst
 create mode 100644 documentation/contributor-guide/index.rst
 rename documentation/{dev-manual/changes.rst => contributor-guide/submit-change.rst} (85%)
 create mode 100644 documentation/contributor-guide/submit-defect.rst
documentation/bsp-guide/bsp.rst +2 -2
index 4d64c65d91..52a07cfcb0 100644
@@ -927,8 +927,8 @@ Yocto Project:
    -  The name and contact information for the BSP layer maintainer.
       This is the person to whom patches and questions should be sent.
       For information on how to find the right person, see the
-      ":ref:`dev-manual/changes:submitting a change to the yocto project`"
-      section in the Yocto Project Development Tasks Manual.
+      :doc:`../contributor-guide/submit-change` section in the Yocto Project and
+      OpenEmbedded Contributor Guide.
 
    -  Instructions on how to build the BSP using the BSP layer.
 
documentation/contributor-guide/identify-component.rst new file +29 -0
new file mode 100644
index 0000000000..ba7c998888
@@ -0,0 +1,29 @@
+.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
+
+Identify the component
+**********************
+
+The Yocto Project and OpenEmbedded ecosystem is built of :term:`layers <Layer>`
+so the first step is to identify the component where the issue likely lies.
+For example, if you have a hardware issue, it is likely related to the BSP
+you are using and the best place to seek advice would be from the BSP provider
+or :term:`layer`. If the issue is a build/configuration one and a distro is in
+use, they would likely be the first place to ask questions. If the issue is a
+generic one and/or in the core classes or metadata, the core layer or BitBake
+might be the appropriate component.
+
+Each metadata layer being used should contain a ``README`` file and that should
+explain where to report issues, where to send changes and how to contact the
+maintainers.
+
+If the issue is in the core metadata layer (OpenEmbedded-Core) or in BitBake,
+issues can be reported in the :yocto_bugs:`Yocto Project Bugzilla <>`. The
+:yocto_lists:`yocto </g/yocto>` mailing list is a general “catch-all” location
+where questions can be sent if you can’t work out where something should go.
+
+:term:`Poky` is a commonly used “combination” repository where multiple
+components have been combined (``bitbake``, ``openembedded-core``,
+``meta-yocto`` and ``yocto-docs``). Patches should be submitted against
+the appropriate individual component rather than :term:`Poky` itself as
+detailed in the appropriate ``README`` file.
+
documentation/contributor-guide/index.rst new file +25 -0
new file mode 100644
index 0000000000..d723854843
@@ -0,0 +1,25 @@
+.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
+
+================================================
+Yocto Project and OpenEmbedded Contributor Guide
+================================================
+
+The Yocto Project and OpenEmbedded are open-source, community-based projects so
+contributions are very welcome, it is how the code evolves and everyone can
+effect change. Contributions take different forms, if you have a fix for an
+issue you’ve run into, a patch is the most appropriate way to contribute it.
+If you run into an issue but don’t have a solution, opening a defect in
+:yocto_bugs:`Bugzilla <>` or asking questions on the mailing lists might be
+more appropriate. This guide intends to point you in the right direction to
+this.
+
+
+.. toctree::
+   :caption: Table of Contents
+   :numbered:
+
+   identify-component
+   submit-defect
+   submit-change
+
+.. include:: /boilerplate.rst
documentation/contributor-guide/submit-change.rst renamed from documentation/dev-manual/changes.rst +20 -82

165 lines not on this page · raw message

documentation/contributor-guide/submit-defect.rst new file +67 -0

67 lines not on this page · raw message

documentation/dev-manual/debugging.rst +2 -5
index 3c5609cef5..3a8d5080ce 100644
@@ -879,8 +879,7 @@ The build should work without issue.
 As with all solved problems, if they originated upstream, you need to
 submit the fix for the recipe in OE-Core and upstream so that the
 problem is taken care of at its source. See the
-":ref:`dev-manual/changes:submitting a change to the yocto project`"
-section for more information.
+":doc:`../contributor-guide/submit-change`" section for more information.
 
 Debugging With the GNU Project Debugger (GDB) Remotely
 ======================================================
@@ -1236,9 +1235,7 @@ Here are some other tips that you might find useful:
    :yocto_bugs:`Bugzilla <>`. For information on
    how to submit a bug against the Yocto Project, see the Yocto Project
    Bugzilla :yocto_wiki:`wiki page </Bugzilla_Configuration_and_Bug_Tracking>`
-   and the
-   ":ref:`dev-manual/changes:submitting a defect against the yocto project`"
-   section.
+   and the ":doc:`../contributor-guide/submit-defect`" section.
 
    .. note::
 
documentation/dev-manual/index.rst +0 -3
index b0bb5576ad..3106b90a45 100644
@@ -4,8 +4,6 @@
 Yocto Project Development Tasks Manual
 ======================================
 
-|
-
 .. toctree::
    :caption: Table of Contents
    :numbered:
@@ -43,7 +41,6 @@ Yocto Project Development Tasks Manual
    build-quality
    runtime-testing
    debugging
-   changes
    licenses
    vulnerabilities
    sbom
documentation/dev-manual/start.rst +4 -5
index 4881481044..372959d9ed 100644
@@ -246,14 +246,13 @@ particular working environment and set of practices.
     -  The Yocto Project community encourages you to send patches to the
        project to fix bugs or add features. If you do submit patches,
        follow the project commit guidelines for writing good commit
-       messages. See the
-       ":ref:`dev-manual/changes:submitting a change to the yocto project`"
-       section.
+       messages. See the ":doc:`../contributor-guide/submit-change`"
+       section in the Yocto Project and OpenEmbedded Contributor Guide.
 
     -  Send changes to the core sooner than later as others are likely
        to run into the same issues. For some guidance on mailing lists
-       to use, see the list in the
-       ":ref:`dev-manual/changes:submitting a change to the yocto project`"
+       to use, see the lists in the
+       ":ref:`contributor-guide/submit-change:finding a suitable mailing list`"
        section. For a description
        of the available mailing lists, see the ":ref:`resources-mailinglist`" section in
        the Yocto Project Reference Manual.
documentation/dev-manual/vulnerabilities.rst +1 -1
index 6d87d02ecb..297789dae6 100644
@@ -22,7 +22,7 @@ issues may be impacting Poky and OE-Core. It is up to the maintainers, users,
 contributors and anyone interested in the issues to investigate and possibly fix them by
 updating software components to newer versions or by applying patches to address them.
 It is recommended to work with Poky and OE-Core upstream maintainers and submit
-patches to fix them, see ":ref:`dev-manual/changes:submitting a change to the yocto project`" for details.
+patches to fix them, see ":doc:`../contributor-guide/submit-change`" for details.
 
 Vulnerability check at build time
 =================================
documentation/index.rst +1 -0
index 6335c707e0..4d0231503d 100644
@@ -34,6 +34,7 @@ Welcome to the Yocto Project Documentation
    Application Development and the Extensible SDK (eSDK) <sdk-manual/index>
    Toaster Manual <toaster-manual/index>
    Test Environment Manual <test-manual/index>
+   Contributor Guide <contributor-guide/index>
    bitbake
 
 .. toctree::
documentation/overview-manual/development-environment.rst +9 -10
index 6139e7a412..55f34c18da 100644
@@ -232,8 +232,8 @@ and so forth.
 
    For information on finding out who is responsible for (maintains) a
    particular area of code in the Yocto Project, see the
-   ":ref:`dev-manual/changes:submitting a change to the yocto project`"
-   section of the Yocto Project Development Tasks Manual.
+   ":doc:`../contributor-guide/identify-component`"
+   section of the Yocto Project and OpenEmbedded Contributor Guide.
 
 The Yocto Project ``poky`` Git repository also has an upstream
 contribution Git repository named ``poky-contrib``. You can see all the
@@ -264,8 +264,8 @@ push them into the "contrib" area and subsequently request that the
 maintainer include them into an upstream branch. This process is called
 "submitting a patch" or "submitting a change." For information on
 submitting patches and changes, see the
-":ref:`dev-manual/changes:submitting a change to the yocto project`"
-section in the Yocto Project Development Tasks Manual.
+":doc:`../contributor-guide/submit-change`" section in the Yocto Project
+and OpenEmbedded Contributor Guide.
 
 In summary, there is a single point of entry for changes into the
 development branch of the Git repository, which is controlled by the
@@ -328,11 +328,10 @@ Book <https://book.git-scm.com>`__.
    software on which to develop. The Yocto Project has two scripts named
    ``create-pull-request`` and ``send-pull-request`` that ship with the
    release to facilitate this workflow. You can find these scripts in
-   the ``scripts`` folder of the
-   :term:`Source Directory`. For information
+   the ``scripts`` folder of the :term:`Source Directory`. For information
    on how to use these scripts, see the
-   ":ref:`dev-manual/changes:using scripts to push a change upstream and request a pull`"
-   section in the Yocto Project Development Tasks Manual.
+   ":ref:`contributor-guide/submit-change:using scripts to push a change upstream and request a pull`"
+   section in the Yocto Project and OpenEmbedded Contributor Guide.
 
 -  *Patch Workflow:* This workflow allows you to notify the maintainer
    through an email that you have a change (or patch) you would like
@@ -340,8 +339,8 @@ Book <https://book.git-scm.com>`__.
    this type of change, you format the patch and then send the email
    using the Git commands ``git format-patch`` and ``git send-email``.
    For information on how to use these scripts, see the
-   ":ref:`dev-manual/changes:submitting a change to the yocto project`"
-   section in the Yocto Project Development Tasks Manual.
+   ":doc:`../contributor-guide/submit-change`" section in the Yocto Project
+   and OpenEmbedded Contributor Guide.
 
 Git
 ===
documentation/ref-manual/resources.rst +3 -4
index d2344e39a0..324d1fad10 100644
@@ -23,8 +23,7 @@ The Yocto Project gladly accepts contributions. You can submit changes
 to the project either by creating and sending pull requests, or by
 submitting patches through email. For information on how to do both as
 well as information on how to identify the maintainer for each area of
-code, see the ":ref:`dev-manual/changes:submitting a change to the yocto project`" section in the
-Yocto Project Development Tasks Manual.
+code, see the :doc:`../contributor-guide/index`.
 
 .. _resources-bugtracker:
 
@@ -46,8 +45,8 @@ your expectations).
 For a general procedure and guidelines on how to use Bugzilla to submit a bug
 against the Yocto Project, see the following:
 
--  The ":ref:`dev-manual/changes:submitting a defect against the yocto project`"
-   section in the Yocto Project Development Tasks Manual.
+-  The ":doc:`../contributor-guide/submit-defect`"
+   section in the Yocto Project and OpenEmbedded Contributor Guide.
 
 -  The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`
 
documentation/ref-manual/system-requirements.rst +2 -2
index d6e8b4583c..3c2f979a6d 100644
@@ -114,8 +114,8 @@ Currently, the Yocto Project is supported on the following distributions:
       interested in hearing about your experience. For information on
       how to submit a bug, see the Yocto Project
       :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>`
-      and the ":ref:`dev-manual/changes:submitting a defect against the yocto project`"
-      section in the Yocto Project Development Tasks Manual.
+      and the ":doc:`../contributor-guide/submit-defect`"
+      section in the Yocto Project and OpenEmbedded Contributor Guide.
 
 
 Required Packages for the Build Host
Signature · 1 line
2.34.1