+1

Thanks for helping with this, Michelle. I think Paul has a great idea. I 
seem to remember reading that our code contribution process can be 
pretty opaque.

Thanks in advance to Allyson for her help with the web site.

Do we want this list to include the PSARC process, or can that be 
considered being part of the sponsor item? If so, might it help anyway 
so new code contributors know what will happen?

Michelle Olson wrote:
> Hi Paul,
> 
> Thanks for writing up this list, I don't think it exists somewhere else. 
> I'd suggest that you request technical review of this content on the 
> request-sponsor discussion list, just to ensure there are no 
> inaccuracies or omissions. Then, I think it should be added to the 
> information on this page, or added as a child page to this one:
> http://opensolaris.org/os/communities/participation/#code
> 
> We should of course link to it from the docs community pages wherever it 
> is most appropriate. I'm happy to help conduct or request these reviews 
> and help to get changes made to the participation page above to make 
> things more clear. Alysson Troffer is our contact on the editorial board 
> for the web site, so I copy her here. I appreciate your time to write 
> this up and send it out.
> 
> Regards,
> Michelle Olson
> OpenSolaris Documentation Community Leader
> 
> 
> Paul Armstrong wrote:
>> I've been poking around for a while and although there's lots of good 
>> documentation for many things I can't find a step by step list of things you 
>> need to do to contribute code.
>>
>> I'm not talking about some behemoth like the OpenSolaris Developers 
>> Reference (which is also missing things like how to generate a webrev), but 
>> something more like:
>>
>> 0. Create a workspace and become familiar with building (pointer to docs 
>> (maybe also http://www.opensolaris.org/os/community/on/install_quickstart/))
>> 1. Find or file a bug (http://bugs.opensolaris.org or 
>> http://defect.opensolaris.org)
>> 2. Request a sponsor (pointer to sponsor documentation)
>> 2.1 If it's large amounts of code or adding a binary/library (give list of 
>> other things that might require ARC) then file an ARC case (link to ARC docs)
>> 3. Write code (link to dev guides)
>> 3.1 Check your code meets style (pointer to style section of docs)
>> 3.2 Other pre-build checks you should do (e.g. IPv6) may be a pre-build 
>> checklist or list of pointers to sections of the dev guide
>> 4. Build and test code
>> 5. Generate and upload a webrev (pointer to webrev documentation (which 
>> seems to only be here 
>> http://blogs.sun.com/tdh/entry/getting_a_webrev_generated_for))
>> 6. Request code review from your sponsor
>> 7. Fix any bugs pointed out by the sponsor
>> 8. goto 4
>> 9. Done?
>>
>> Does such a thing exist and my search foo is failing?
>> Such a thing would be great from a "New to developing OpenSolaris? Here's 
>> the checklist" point of view as it's a single place to go, has pointers to 
>> everything you need to know and is short so it's not overwhelming (and is 
>> also easier to consume for a programmer who only has a small number of hours 
>> a week to devote to OpenSolaris).
>>
>> Paul

Rainer
-- 
Mind the gap.

Reply via email to