Commit Graph

21 Commits

Author SHA1 Message Date
Trevor Woerner
941f3a9527 contributor-guide/submit-changes: encourage patch version changelogs
Add a section after the 'git format-patch' information encouraging developers
to add patch version changelogs to their patch updates.

(From yocto-docs rev: 78fd3b3f1ec797dfe3648509a1945241b50640d5)

Signed-off-by: Trevor Woerner <twoerner@gmail.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 2e3a37c4607b296956993e557d1786c4876e5722)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2025-05-19 08:32:49 -07:00
Antonin Godard
6147489ce5 contributor-guide/submit-changes: add policy on AI generated code
Based on message by Richard Purdie on the yocto-docs list:
https://lists.yoctoproject.org/g/docs/message/6300

Re-formatted for the Yocto Project documentation syntax.

(From yocto-docs rev: da3aa5ba9387ca5bb7ddd75fe6f7962d0629ea90)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit a72dd13e6841b621c9e8f904dfaa440c186d2959)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2025-02-21 06:25:06 -08:00
Antonin Godard
1c0c8e4b90 contributor-guide/submit-changes.rst: suggest to remove the git signature
By default when sending patches Git adds the git version at the bottom
of the patch, which is not necessary in most cases. Suggest to remove it
when configuring Git when sending patches.

Suggested-By: Jaekyu Lee <jaekyu.lee@lge.com>
(From yocto-docs rev: 05455e916b3c94a73b358ac4f4189cc66bec35f2)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit d3465691231f10466703198a831a681803ffdfad)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2025-01-09 06:25:36 -08:00
Talel BELHAJSALEM
4c01aca2ec contributor-guide: Remove duplicated words
Remove "and then" as it is duplicated.

(From yocto-docs rev: 4eb28bf7e1ee52ee5abb5302169685d849cf1b91)

Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 52ed947120e400620277a58f895294b558a9324e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2024-11-18 06:59:35 -08:00
Quentin Schulz
4de1b38922 manuals: refer to new yocto-patches mailing list wherever appropriate
There's a new yocto-patches mailing list available for all layers that
do not have their own mailing list.

c.f. https://lists.yoctoproject.org/g/yocto/topic/105197684

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: ac512f76b93a20507a6835ddafa954b4ae45e268)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-04-08 14:36:38 +01:00
Martin Jansa
8a8040b37e contributor-guide: be more specific about meta-* trees
* this is often confused to apply for e.g. meta-oe as well
  where it doesn't apply as meta-oe has own ML mentioned
  in README.

(From yocto-docs rev: 63be0814a7ecf38c570b6d776f62b7c7803eb299)

Signed-off-by: Martin Jansa <martin.jansa@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-03-19 15:22:27 +00:00
Simone Weiß
f9e1cfe9e8 contributor-guide: add notes for tests
This adds some hints that and how changes should be tested when contributing.

Fixes [YOCTO #15412]

(From yocto-docs rev: 6f3dbb2a909ba5b71efb09b251ee3f8650e30146)

Signed-off-by: Simone Weiß <simone.p.weiss@posteo.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-03-06 16:54:54 +00:00
baruch@tkos.co.il
c71f5236a4 contributor-guide: fix lore URL
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>
(From yocto-docs rev: 5962a09a120681c1328e05335c2f14fad06c63ce)

Signed-off-by: Baruch Siach <baruch@tkos.co.il>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-02-05 14:30:34 +00:00
Michael Opdenacker
120ac9aa8b contributor-guide: use "apt" instead of "aptitude"
As used in the rest of the manual.

(From yocto-docs rev: 5a5dfc446bb62568da50056660d18c5c309d1051)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-01-12 11:34:05 +00:00
Michael Opdenacker
dbcc4df413 contributor-guide: fix command option
"--subject-prefix" applies to "git format-patch", not "git send-email"

(From yocto-docs rev: d0e255f4ace445e076f37d42bbc69378f5985c59)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-12-01 17:45:06 +00:00
Trevor Gamblin
884c37f6fd contributor-guide: clarify patchtest usage
- Make it clear that patchtest only supports openembedded-core for now
- Add a short list of instructions for installing Python module
  dependencies on the host
- Add a step to add meta-selftest with bitbake layers so that all tests
  can run

(From yocto-docs rev: bcd58d68e72226be1930593f5f7fb37de15b7913)

Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
Trevor Gamblin
544da7651d contributor-guide: add patchtest section
(From yocto-docs rev: 236cd04d62bdf653aae9b41d32d9f87848a34339)

Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-10-20 14:40:29 +01:00
Michael Opdenacker
266cab4530 contributor-guide: submit-changes: how to request push access to repositories
Including content currently on
http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded

(From yocto-docs rev: 34b22fd3c48d55bcddbf725395f9ee4e389ae354)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30 15:54:59 +01:00
Michael Opdenacker
81f99caf91 contributor-guide: submit-changes: commit guidelines for recipes
Adding text currently on
http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded

(From yocto-docs rev: 716756045b75e64846421dcecdd044a06b88052a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30 15:54:59 +01:00
Michael Opdenacker
c6f0512d22 contributor-guide: submit-changes: improvements to mailing lists section
- Add missing reference to openembedded-devel list

- Improve the text to clarify explanations, remove redundant information
  and include information currently on
  http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded

(From yocto-docs rev: a359be596138d0454c7596ccbfd48f7ad307980a)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30 15:54:59 +01:00
Michael Opdenacker
a878e1591b contributor-guide: submit-changes: reorganize and develop sections
In particular, develop the sections about sending patches.
Reorder sections for a more logical flow.
Remove unnecessary or duplicate details too.

(From yocto-docs rev: 6c37d5bd9be7e65c923c3e95f478afc0e6064e8f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30 15:54:59 +01:00
Michael Opdenacker
e05baab43c manuals: README: update list of manuals
(From yocto-docs rev: 30166df4a85a2bbd1da98440e701de72e56fa9f3)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30 15:54:59 +01:00
Michael Opdenacker
ab25d680aa contributor-guide: submit-changes: develop sending patches section
(From yocto-docs rev: 0cfb8417236a8a82eebe7901bc24164227cfe4b2)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30 15:54:59 +01:00
Michael Opdenacker
74be88d8af contributor-guide: submit-changes: detail commit and patch creation
Add missing steps and try to provide better guidance and more modern
solutions, for example keeping track of the cover letter in the branch
itself.

Also add subsections to divide the instructions into easier
to understand parts.

(From yocto-docs rev: 4abe87cb20d3f023d5b0178450823d072d3321c8)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30 15:54:59 +01:00
Michael Opdenacker
90b99c1a03 contributor-guide: submit-changes: simplify note
(From yocto-docs rev: fb507fb37fe0c078144932ff39ba0ef952614361)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30 15:54:59 +01:00
Michael Opdenacker
9bf8250a40 contributor guide: update instructions for making and sharing changes
- Shifting the focus to multiple changes instead of just one
- Advising to create a branch for changes
- Removing unnecessary or too verbose explanations
- Adding useful resources and examples

(From yocto-docs rev: e7e47121fd979e034f8f40a043912640a6a25a5e)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-08-30 15:54:59 +01:00