Difference between revisions of "Development:Contributor Overview"

Latest revision as of 14:08, 7 December 2008

This page will be one of the main pages of the dev-wiki; it will walk a new contributor through the process in an overview fashion, pointing to the detailed information on each part in the separate docs, e.g. building/setting up your dev environment, choosing a bug, coding, getting reviews.

Things in the lists below the text are the pages we should link to

We should also see if there's anything useful on http://www.caminobrowser.org/development/programming/, either for this page itself or for the subpages we're going to refer to; this page is intended to replace http://www.caminobrowser.org/development/programming/

DRAFT

This page is not complete.

Welcome

Welcome to Camino. Interested in becoming a contributor? We're glad to have you on board. This page documents some basic information on how to make the leap from Camino fan to Camino dev, from getting Camino built, to picking out bugs to fix, to getting patches written and checked in. Even if you've contributed to Mozilla-based projects before, you may find this information useful, as much of it is Camino-specific.

Setting up your development environment

Like most complex pieces of software, the Mozilla project requires a flexible build system, which is not always straightforward. Unlike many open-source projects, ./configure; make does not suffice. Similarly, Camino, which embeds the cross-platform Gecko engine in a Cocoa application, depends on a somewhat hybrid build system; in other words, unlike other Cocoa apps, simply opening Xcode and clicking build won't produce a complete Camino application.

While this may seem daunting at first, the system is quite logical and there's very little effort involved in making it work. Gecko is built entirely using UNIX-style makefiles, and the Camino application code can be built either via makefiles or with Xcode once Gecko has been built (for the curious, this provides an overview of the Mozilla build system from a technical perspective).

Setting up your development environment entails installing the latest Xcode and appropriate SDKs, installing the three third-party dependencies, setting up your build options, and pulling cvs and building. The following documents will guide you through these steps.

Development:Building
Development:Building:Build Errors (in case you run into problems)

Choosing a bug

All decisions concerning which bugfixes and features should be implemented in Camino are made in the bugzilla bug-tracking database, on irc.mozilla.org, channel #camino (or during weekly meetings in #camino-mtg), or during annual Camino face-to-face meetings.

Something that bothers you, something on good first bugs, something that needs to be fixed...

Good First Bug vs. Triage Priority

The "Good First Bugs" list is a list of "bugs" (problems or feature requests) that are good entry points for new Camino developers, not necessarily a list of the bugs that need to be fixed most urgently. A bug's priority is determined (roughly) by the severity field, the priority field (used generally by developers to prioritize lists of bugs assigned to them), the target milestone, and the blocking flags. For instance, bugs with a target milestone of Camino 1.6 are generally most important at the moment, and ones with higher severity (or a camino1.6+ or camino1.6? flag) are the most important of those.

Bugs Targeted at Camino 1.6
Somewhere we should have an "Unofficial" Roadmap for Developers with bugs or categories of bugs for a release, like the Firefox PRD but more humane, to supplement the "target milestone" queries--a more-official version of Sam's Roadmap or Smokey's 1.1 list
- For 1.6, this is Development:Planning:Camino 1.6
Tracking Documents
Development:Roadmap
Stuff we'd like fixed: Development:Good Bugs and Projects
- Some members of the team have compiled personal lists of bugs they think need to be fixed, or that people commonly complain about: User:Sardisson/Dogfood, User:Sardisson/Camino_1.1, User:Sardisson/Camino_1.2
- Camino Vote List (only bugs with 5 or more votes; what our Bugzilla-using users would like fixed)
  Camino 1.5 saw the fixing of many of the top high vote-getters
- "Good First Bug" query
QA:Keywords & Status Whiteboard for more info on keywords and the whiteboard
- helpwanted query
- regression query

Working on a bug

When to take a bug, and how to do it (some of this is in the existing cbo dev pages)
Bugs with status NEW whose assignees are either nobody@mozilla.org and sfraser_bugs@smfr.org are fair game
Ask first before taking a bug with status NEW with any other assignee, or before taking a bug with status ASSI.

Development:Good Bugs and Projects
Development:Roadmap
Tracking Documents
Camino code structure
[10:47pm] froodian: if you just want to get a feel for the code, the meat of Camino is in:
[10:47pm] froodian: mozilla/camino/src/browser/BrowserWindowController.mm
[10:47pm] ardissone|away: aka BWC
[10:47pm] froodian: and mozilla/camino/src/application/MainController.mm
The relationship between the various content views is described in ASCII art in http://mxr.mozilla.org/mozilla/source/camino/src/browser/BrowserContentViews.mm
- Unfortunately, tabs themselves need a similar mockup
etc

Coding a fix

Text, text, text

Development:Coding
Also some of the Tools bits on Development:Home Page (needs either own page or to move here)

Getting Code Review and Checkin

Text, text, text

Development:Reviewing

Links and Recommended Reading

Stuff from the sidebars in cbo/development (below)
Anything else?

Sections

<a href="/development/" accesskey="I">Contributor Introduction</a>
<a href="/development/programming/" accesskey="P">Programming</a>
<a href="/development/build/" id="current" accesskey="B">Build Instructions</a>
<a href="/development/roadmap/" accesskey="R">Roadmap</a>
<a href="/development/structure/" accesskey="T">Team Structure</a>

@@ Line 2: / Line 2: @@
 ''Things in the lists below the text are the pages we should link to''
+''We should also see if there's anything useful on http://www.caminobrowser.org/development/programming/, either for this page itself or for the subpages we're going to refer to; this page is intended to replace http://www.caminobrowser.org/development/programming/''
+{{draft}}
 ==Welcome==
+Welcome to Camino.  Interested in becoming a contributor?  We're glad to have you on board.  This page documents some basic information on how to make the leap from Camino fan to Camino dev, from getting Camino built, to picking out bugs to fix, to getting patches written and checked in.  Even if you've contributed to Mozilla-based projects before, you may find this information useful, as much of it is Camino-specific.
 ==Setting up your development environment==
-Text text text
+Like most complex pieces of software, the Mozilla project requires a flexible build system, which is not always straightforward.  Unlike many open-source projects, <tt>./configure; make</tt> does not suffice.  Similarly, Camino, which embeds the cross-platform Gecko engine in a Cocoa application, depends on a somewhat hybrid build system; in other words, unlike other Cocoa apps, simply opening Xcode and clicking build won't produce a complete Camino application.
+While this may seem daunting at first, the system is quite logical and there's very little effort involved in making it work.  Gecko is built entirely using UNIX-style makefiles, and the Camino application code can be built either via makefiles or with Xcode once Gecko has been built (for the curious, [http://developer.mozilla.org/en/docs/How_Mozilla%27s_build_system_works this] provides an overview of the Mozilla build system from a technical perspective).
+Setting up your development environment entails installing the latest Xcode and appropriate SDKs, installing the three third-party dependencies, setting up your build options, and pulling cvs and building.  The following documents will guide you through these steps.
 *[[Development:Building]]
-*[[Development:Building:Intel]]
+<!--*[[Development:Building:Intel]]
+*: Make sure the final docs have some notes on rebuilding/updating.  Most Camino developers only update and rebuild Gecko about once a week (or when Gecko changes also change Camino code) unless they're working on things in embedding or widget.-->
+*[[Development:Building:Build Errors]] (in case you run into problems)
 ==Choosing a bug==
-Something that bothers you, something on good first bugs, something that needs to be fixed...
+All decisions concerning which bugfixes and features should be implemented in Camino are made in the [https://bugzilla.mozilla.org/ bugzilla] bug-tracking database, on [irc://irc.mozilla.org irc.mozilla.org], channel #camino (or during [[Status Meetings|weekly meetings]] in #camino-mtg), or during annual Camino [[Camino_Meet-up|face-to-face meetings]].
+* ''Something that bothers you, something on good first bugs, something that needs to be fixed...''
 ===Good First Bug vs. Triage Priority===
-The "Good First Bugs" list is a list of "bugs" (problems or feature requests) that are good entry points for new Camino developers, not necessarily a list of the bugs that need to be fixed most urgently.  A bug's priority is determined (roughly) by the severity field, the priority field (used generally by developers to prioritize lists of bugs assigned to them), the target milestone, and the blocking flags.  For instance, bugs with a target milestone of Camino 1.1 are generally most important at the moment, and ones with higher severity (or a camino1.1+ or camino1.1? flag) are the most important of those.
+The "Good First Bugs" list is a list of "bugs" (problems or feature requests) that are good entry points for new Camino developers, not necessarily a list of the bugs that need to be fixed most urgently.  A bug's priority is determined (roughly) by the severity field, the priority field (used generally by developers to prioritize lists of bugs assigned to them), the target milestone, and the blocking flags.  For instance, bugs with a target milestone of Camino 1.6 are generally most important at the moment, and ones with higher severity (or a camino1.6+ or camino1.6? flag) are the most important of those.
-* Bugs Targeted at Camino 1.1
+* [https://bugzilla.mozilla.org/buglist.cgi?query_format=advanced&product=Camino&target_milestone=Camino1.6&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&cmdtype=doit&order=Reuse+same+sort+as+last+time Bugs Targeted at Camino 1.6]
 * ''Somewhere we should have an "Unofficial" Roadmap for Developers with bugs or categories of bugs for a release, like the Firefox PRD but more humane, to supplement the "target milestone" queries--a more-official version of Sam's Roadmap or Smokey's 1.1 list''
+** For 1.6, this is [[Development:Planning:Camino 1.6]]
+* [[Development:Home_Page#Tracking_Documents|Tracking Documents]]
+* [[Development:Roadmap]]
 * Stuff we'd like fixed: [[Development:Good Bugs and Projects]]
+** Some members of the team have compiled personal lists of bugs they think need to be fixed, or that people commonly complain about: [[User:Sardisson/Dogfood]], [[User:Sardisson/Camino_1.1]], [[User:Sardisson/Camino_1.2]]
+** [https://bugzilla.mozilla.org/buglist.cgi?query_format=advanced&product=Camino&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&votes=5&order=bugs.votes,bugs.delta_ts%2Cbugs.bug_status%2Cbugs.priority%2Cmap_assigned_to.login_name%2Cbugs.bug_id Camino Vote List] (only bugs with 5 or more votes; what our Bugzilla-using users would like fixed)
+**: ''Camino 1.5 saw the fixing of many of the top high vote-getters''
+**  [https://bugzilla.mozilla.org/buglist.cgi?query_format=advanced&product=Camino&status_whiteboard_type=allwordssubstr&status_whiteboard=%5Bgood+first+bug%5D&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED "Good First Bug" query]
+* [[QA:Keywords & Status Whiteboard]] for more info on keywords and the whiteboard
+** [https://bugzilla.mozilla.org/buglist.cgi?query_format=advanced&product=Camino&keywords_type=allwords&keywords=helpwanted&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=Reuse+same+sort+as+last+time helpwanted] query
+** [https://bugzilla.mozilla.org/buglist.cgi?query_format=advanced&product=Camino&keywords_type=allwords&keywords=regression&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&chfieldto=Now regression] query
 ===Working on a bug===
 * When to take a bug, and how to do it (some of this is in the existing cbo dev pages)
-* Bugs with status '''NEW''' whose assignee is ''nobody@mozilla.org'', ''mikepinkerton@mac.com'', and  ''sfraser_bugs@smfr.org'' are fair game
+* Bugs with status '''NEW''' whose assignees are either ''nobody@mozilla.org'' and  ''sfraser_bugs@smfr.org'' are fair game
 * Ask first before taking a bug with status '''NEW''' with any other assignee, or before taking a bug with status '''ASSI'''.
 *[[Development:Good Bugs and Projects]]
-*Roadmap
+*[[Development:Roadmap]]
+* [[Development:Home_Page#Tracking_Documents|Tracking Documents]]
+* Camino code structure
+*: [10:47pm] froodian: if you just want to get a feel for the code, the meat of Camino is in:<br>[10:47pm] froodian: mozilla/camino/src/browser/BrowserWindowController.mm<br>[10:47pm] ardissone|away: aka BWC <br>[10:47pm] froodian: and mozilla/camino/src/application/MainController.mm<br>
+* The relationship between the various content views is described in ASCII art in http://mxr.mozilla.org/mozilla/source/camino/src/browser/BrowserContentViews.mm
+** Unfortunately, tabs themselves need a similar mockup
 *etc
@@ Line 34: / Line 62: @@
 Text, text, text
-*[[Development:Reviewing]] (prob needs a new page name)
+*[[Development:Coding]]
+* Also some of the Tools bits on [[Development:Home Page]] (needs either own page or to move here)
 ==Getting Code Review and Checkin==
 Text, text, text
-*[[Development:Reviewing]] (other parts of the page, or split the page in 2)
+*[[Development:Reviewing]]
+==Links and Recommended Reading==
+*Stuff from the sidebars in cbo/development (below)
+* Anything else?
+===Sections===
+<ol>
+          <li><a href="/development/" accesskey="I">Contributor <u>I</u>ntroduction</a></li>
+          <li><a href="/development/programming/" accesskey="P"><u>P</u>rogramming</a></li>
+          <li><a href="/development/build/" id="current" accesskey="B"><u>B</u>uild Instructions</a></li>
+          <li><a href="/development/roadmap/" accesskey="R"><u>R</u>oadmap</a></li>
+          <li><a href="/development/structure/" accesskey="T"><u>T</u>eam Structure</a> </li>
+</ol>
+===Requirements===
+*[https://bugzilla.mozilla.org/createaccount.cgi Register at Bugzilla]
+*[https://bugzilla.mozilla.org/enter_bug.cgi?format=guided&amp;product=Camino Report a Camino bug]
+*[https://bugzilla.mozilla.org/enter_bug.cgi?format=guided&amp;product=Core Report a Mozilla bug]
+*[http://www.mozilla.org/quality/bug-writing-guidelines.html Bug writing guidelines]
+*[https://bugzilla.mozilla.org/query.cgi Search for bugs]
+*[https://bugzilla.mozilla.org/buglist.cgi?product=Camino&amp;bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;changedin=14&amp;chfieldto=Now Recent active bugs]
+*[https://bugzilla.mozilla.org/buglist.cgi?product=Camino&amp;bug_status=UNCONFIRMED Unconfirmed bugs]
+*[http://www.mozilla.org/hacking/ Mozilla hacking documents]
+*[http://bonsai.mozilla.org/cvsquery.cgi?treeid=default&amp;module=Camino&amp;branch=&amp;branchtype=match&amp;dir=%2Fmozilla%2Fcamino&amp;file=&amp;filetype=match&amp;who=&amp;whotype=match&amp;hours=2&amp;date=week&amp;mindate=&amp;maxdate=&amp;cvsroot=%2Fcvsroot Last week's Camino check-ins]
+*[http://bonsaibugs.org/pyblosxom.cgi/camino Latest Mozilla tree checkins]
+*[http://fink.sourceforge.net/index.php Fink Project]
+*[http://developer.apple.com/cocoa/ Apple Cocoa]
+<!-- END Quick Links -->
+<!-- BEGIN Books -->
+===Recommended Reading===
+*[http://www.amazon.com/exec/obidos/ASIN/0596004702/ Learn Unix for Mac OS X]
+*[http://www.amazon.com/exec/obidos/tg/detail/-/0321213149/qid=1111520306/sr=1-2/ref=sr_1_2/104-8082258-4999151?v=glance&amp;s=books Cocoa Programming for Mac OS X]

Difference between revisions of "Development:Contributor Overview"

Latest revision as of 14:08, 7 December 2008

Contents

Welcome

Setting up your development environment

Choosing a bug

Good First Bug vs. Triage Priority

Working on a bug

Coding a fix

Getting Code Review and Checkin

Links and Recommended Reading

Sections

Requirements

Recommended Reading

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools