On 06/10/09 07:16 PM, Michelle Olson wrote:
Hi all,
I've drafted a short document (based on the original
http://opensolaris.org/os/communities/participation/ page) that
describes how to contribute code:
http://hub.opensolaris.org/bin/view/Main/ContributorHandbook
Let me know what you think.
Thanks,
Michelle
Some suggestions to use as you see fit:
Introduction:
- Suggest changing "interests in the code" to "interests in the
contribution" since a contribution requiring an SCA can be
other than code
Filing Bugs
- I worry that no one knows what 'OpenSolaris core platform code'
actually is and that we don't come out and say there are two systems.
It's impossible to explain, but I think I'd say something like the
following:
Two bug databases can be accessed from opensolaris.org:
- bugs.opensolaris.org is a mechanism that allows submissions
into Sun's bug database and limited queries of that database.
- defect.opensolaris.org is an instance of Bugzilla that provides
an open source defect tracking system.
Use the <simple form> at bugs.opensolaris.org to file bugs against
Solaris releases. Before submitting a new bug, please <perform a
search> to ensure that the bug has not already been filed. Use of
bugs.opensolaris.org requires registration.
Use defect.opensolaris.org to file bugs against releases of the
OpenSolaris distribution and against projects being developed
on opensolaris.org. Before submitting a new bug, please <perform
a search> to ensure that the bug has not already been filed.
(Filing a bug in defect.os.org requires registration there, yes?
But I think searching does not. Eventually, we'll have a single
search mechanism and defect.os.org will be integrated with auth,
but I don't have dates for any of that yet, so for now we're just
stuck with the current reality.)
(I would move 'Contributing Code' to here and add information to it to
distinguish between projects and consolidations. The Sponsor Program
overall is what has integrated over 400 fixes - not just ON, and the
Sponsor Program only applies applies to some consolidations. Multiple
Projecs track their bugs in defect.os.org. oss-bite-size bugs are
marked in all the consolidations, not just ON.)
Contributing Code
If you are interested in fixing bugs and developing code, exactly
how you do that depends on the code involved.
- Project
If you are interested in a Project, subscribe to its mailing list
and get to know people on that team. Let them know you're
interested in helping, and they will let you know how to work on that
code. The list of available projects is <here>. Or you can start
your own <instructions>.
- Consolidation
OpenSolaris is divided into major components called 'consolidations'.
The <downloads> page contains a list of the consolidations with
pointers to information about them. Choose the one in which you are
interested, and its pages will explain how to develop code and submit
changes.
The development process differs between consolidations. Some have
parts or all of their source on opensolaris.org and can allow
contributors to commit changes directly to source code. Others have
not yet been able to move their main source gates to opensolaris.org
and take contributions via the <Sponsor Program>.
Each consolidation can provide specifics about their development
processes, steps involved, tools available, etc.
If you decide to work on consolidation code, you can search Sun's
bug database via bugs.opensolaris.org to find bugs or Requests for
Enhancement (RFEs) to work on.
Some bugs in this database are marked with the "oss-bite-size"
keyword. These bugs were marked by the team that owns the code to
identify small, self-contained areas of work. These are good places
to start if you are new to working on OpenSolaris code.
- Sponsor Program
If you decide to work on consolidation code that requires a Sponsor,
and you have determined that no one is already working on the bug,
send email to ......
......
A sponsor will volunteer to help you through the development
processes.
See also:
- Projects page (for list of Projects)
- Downloads page (for list of consolidations)
- Request-sponsor table (table of all the contributions arranged by
state that have been submitted via the Sponsor Program)
- Sun Contributor Agreement information (must file an SCA to
contribute code)
- ON Development Process (details about the ON consolidation
development process)
Contributing Packages
Perhaps put this section next since testing, documenting and
reviewing should apply to all code?
Testing Code Changes
Defer to Jim's suggestions.
Reviewing Code Changes
Seems to come next when you think you're done coding
Documenting Code Changes
Seems like it's last after you know you're done with the code
In this section, add a comment that some consolidations and
projects will require that documentation be delivered with the
code contribution.
Question: Can we explain working on translations in general or is that
specific to each project and consolidation?
_______________________________________________
website-discuss mailing list
[email protected]
