Mozbot/Hacking: Difference between revisions

(Created page with "So you want to help us hack mozbot? Excellent! ==Getting Started== First, you will want to get [download.html#cvs1 the latest mozbot source from CVS]. The easiest way to get i...")
 
 
(2 intermediate revisions by the same user not shown)
Line 10: Line 10:
==Modules==
==Modules==
If you are interested in writing or hacking modules, take a look
If you are interested in writing or hacking modules, take a look
at the [http://mxr.mozilla.org/mozilla/source/webtools/mozbot/BotModules/devel.txt API
at the [http://mxr.mozilla.org/mozilla/source/webtools/mozbot/BotModules/devel.txt API documentation].
documentation].
The easiest way to write a new module is to take an existing one
The easiest way to write a new module is to take an existing one
that does something similar to what you want to do, save it with a
that does something similar to what you want to do, save it with a
Line 17: Line 16:
the coding style similar throughout mozbot's source.
the coding style similar throughout mozbot's source.
If you want to browse the source code online before contributing, you can
If you want to browse the source code online before contributing, you can
[http://mxr.mozilla.org/mozilla/source/webtools/mozbot/ do so using
[http://mxr.mozilla.org/mozilla/source/webtools/mozbot/ do so using the MXR interface to CVS].
the MXR interface to CVS].
 
==The Team==
==The Team==
The mozbot team is a poorly defined group of people. The current module
The mozbot team is a poorly defined group of people. The current module
owner is [irc://irc.mozilla.org/Wolf,isnick Wolf].
owner is [irc://irc.mozilla.org/Wolf,isnick Wolf].
The other people involved with mozbot at the moment include:[irc://irc.mozilla.org/Cww,isnick Cww], [irc://irc.mozilla.org/Jake,isnick Jake], [irc://irc.mozilla.org/justdave,isnick justdave], [irc://irc.mozilla.org/kerz,isnick kerz], [irc://irc.mozilla.org/kiko,isnick kiko], [irc://irc.mozilla.org/timeless,isnick timeless], [irc://irc.mozilla.org/tmyoung,isnick tmyoung], and [irc://irc.mozilla.org/zach,isnick zach]. Some of usare also Bugzilla hackers.
The other people involved with mozbot at the moment include:[irc://irc.mozilla.org/Cww,isnick Cww], [irc://irc.mozilla.org/Jake,isnick Jake], [irc://irc.mozilla.org/justdave,isnick justdave], [irc://irc.mozilla.org/kerz,isnick kerz], [irc://irc.mozilla.org/kiko,isnick kiko], [irc://irc.mozilla.org/timeless,isnick timeless], [irc://irc.mozilla.org/tmyoung,isnick tmyoung], and [irc://irc.mozilla.org/zach,isnick zach]. Some of usare also Bugzilla hackers.
Mozbot development occurs primarily in <a
Mozbot development occurs primarily in [irc://irc.mozilla.org/%23mozwebtools #mozwebtools],
href="irc://irc.mozilla.org/%23mozwebtools #mozwebtools],
and testing occurs primarily in [irc://irc.mozilla.org/%23mozbot #mozbot].
and testing occurs primarily in <a
 
href="irc://irc.mozilla.org/%23mozbot #mozbot].
==Review==
==Review==
Before any patch may be checked into the mozbot source, it must
Before any patch may be checked into the mozbot source, it must
be reviewed by Wolf. To get a patch
be reviewed by Wolf. To get a patch
reviewed, you attach the patch to the relevant Bugzilla bug (if
reviewed, you attach the patch to the relevant Bugzilla bug (if
none yet exists for the issue in question, please [https://bugzilla.mozilla.org/enter_bug.cgi?alias=&assigned_to=nobody%40mozilla.org&blocked=&bug_file_loc=http%3A%2F%2F&bug_severity=normal&bug_status=NEW&comment=&component=Mozbot&contenttypeentry=&contenttypemethod=autodetect&contenttypeselection=text%2Fplain&data=&dependson=&description=&flag_type-4=X&form_name=enter_bug&keywords=&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=All&priority=--&product=Webtools&qa_contact=mozbot%40webtools.bugs&rep_platform=All&short_desc=&target_milestone=---&version=Trunk file
none yet exists for the issue in question, please [https://bugzilla.mozilla.org/enter_bug.cgi?alias=&assigned_to=nobody%40mozilla.org&blocked=&bug_file_loc=http%3A%2F%2F&bug_severity=normal&bug_status=NEW&comment=&component=Mozbot&contenttypeentry=&contenttypemethod=autodetect&contenttypeselection=text%2Fplain&data=&dependson=&description=&flag_type-4=X&form_name=enter_bug&keywords=&maketemplate=Remember%20values%20as%20bookmarkable%20template&op_sys=All&priority=--&product=Webtools&qa_contact=mozbot%40webtools.bugs&rep_platform=All&short_desc=&target_milestone=---&version=Trunk file one]), and add the [https://developer.mozilla.org/en-US/docs/Developer_Guide/How_to_Submit_a_Patch <code>review flag</code>] to your attachment. If you have any
one]), and add the <code>review</code> flag to your attachment. If you have any
questions, feel free to ask.
questions, feel free to ask.

Latest revision as of 21:34, 25 March 2014

So you want to help us hack mozbot? Excellent!

Getting Started

First, you will want to get [download.html#cvs1 the latest mozbot source from CVS]. The easiest way to get into mozbot hacking is to fix a bug. (It is a lot easier to start by poking around in code that already works rather than trying to write new code from scratch.) If you want some other ideas of something to implement, look for XXX comments in the source.

Modules

If you are interested in writing or hacking modules, take a look at the API documentation. The easiest way to write a new module is to take an existing one that does something similar to what you want to do, save it with a new name, and start ripping code out. That will also help to keep the coding style similar throughout mozbot's source. If you want to browse the source code online before contributing, you can do so using the MXR interface to CVS.

The Team

The mozbot team is a poorly defined group of people. The current module owner is Wolf. The other people involved with mozbot at the moment include:Cww, Jake, justdave, kerz, kiko, timeless, tmyoung, and zach. Some of usare also Bugzilla hackers. Mozbot development occurs primarily in #mozwebtools, and testing occurs primarily in #mozbot.

Review

Before any patch may be checked into the mozbot source, it must be reviewed by Wolf. To get a patch reviewed, you attach the patch to the relevant Bugzilla bug (if none yet exists for the issue in question, please file one), and add the review flag to your attachment. If you have any questions, feel free to ask.