Bug 1650 - Need documentation on contributing patches and code
Summary: Need documentation on contributing patches and code
Status: RESOLVED FIXED
Alias: None
Product: Quick Start
Classification: Documentation
Component: quick-start (show other bugs)
Version: unspecified
Hardware: x86 Multiple
: Low enhancement
Target Milestone: 1.4
Assignee: Scott Rifenbark
QA Contact:
URL:
Whiteboard: 17-Nov-2011: Resolved Fixed with 3.8...
Depends on:
Blocks:
 
Reported: 2011-10-05 08:41 UTC by Mark Hatle
Modified: 2013-04-25 10:54 UTC (History)
7 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Mark Hatle 2011-10-05 08:41:48 UTC
I am not able to find documentation (wiki or otherwise) that explains what, where and how to contribute to the Yocto Project, OE-Core and/or bitbake.

The documentation should include information:

*) Generating git patches using the oe-core "create-pull-request"
*) Determining where a patch set needs to be sent [based on directory]

General rules:

bitbake - bitbake-devel mailing list
oe-core components - openembedded-core mailing list
yocto components - poky? or yocto? mailing lists
Comment 1 Mark Hatle 2011-10-05 09:21:48 UTC
Comments from someone new to yocto:

I don't want more nested web pages...  As an outsider looking in, I was simply wanting to know if you changed things in these directories submit patch (of course conforming to guidelines hyper link here) to X@X.LIST

In kernel land it is easy, they provide a script that tells you who to send things to or you can look at the MAINTAINERS file yourself.   You can always link to the MAINTAINERS file in the git tree, if one is created.
Comment 2 Scott Rifenbark 2011-11-17 11:19:47 UTC
Section 3.8 of the Yocto Project Development Manual addresses this bug.  I am marking it resolved and fixed.
Comment 3 Mark Hatle 2011-11-17 11:27:02 UTC
I believe there is a second aspect to this, not documentation based but an enhancement to the source tree itself.  Adding a maintainer -- readme or similar file to the sources.

We've had discussions within the Open Embedded TSC on this, but have had no final conclusion.

I'm going to reopen this, and assign it to myself to until we resolve that issue.
Comment 4 Scott Rifenbark 2011-11-17 13:02:02 UTC
okay - Let me know if any further enhancements to the docs need to be applied.
Comment 5 Darren Hart 2012-05-02 16:33:43 UTC
I've been harping on the including of maintainers on patches, so I'm interested in helping here as well. For Yocto there is the distro-tracking file, but this really needs to be better integrated into oe-core.
Comment 6 Song Liu 2012-05-07 22:39:19 UTC
Changing the target milestone to 1.3 as the remaining work will be completed in that timeframe.
Comment 7 Scott Rifenbark 2012-05-08 18:35:22 UTC
Is this bug still supposed to be assigned to me?  It still is.  Comment history shows that Mark should have it. 

Scott
Comment 8 Richard Purdie 2013-04-25 10:54:12 UTC
We now have readmes in all repos and its part of the Yocto Project Compatible standard.