View source for Auto-tools/Projects/Mozregression

= mozregression = 

== Introduction ==

mozregression is an interactive regression range finder for Mozilla nightly and inbound builds. It uses a binary search algorithm for quickly determining a changeset range corresponding to when a problem was introduced. It is widely use by Mozilla developers and other community members to help find regressions.

To get a feel for how mozregression works, see the video on codefirefox.com: http://codefirefox.com/video/mozregression

Homepage: http://mozilla.github.io/mozregression/

== Active contributors ==

These people are actively working on mozregression and good people to ask questions of (or for review):

* [https://mozillians.org/en-US/u/wlach/ William Lachance]
* [https://github.com/sinemetu1 Sam Garrett]
* [https://mozillians.org/en-US/u/parkouss/ Julien Pagès]

== How to setup for development ==

Assuming you have python, git, and virtualenv installed check out the mozregression repository and install it locally inside there. From there, you should be able to modify the code and test your changes. On Linux and MacOS X, this looks like:

  virtualenv mozr
  cd mozr
  source bin/activate
  git clone https://github.com/mozilla/mozregression.git mozregression
  cd mozregression
  pip install -e .

(Windows instructions should be pretty similar, the only difference should be the activation step)

Check style/bad code issues with flake8:

  pip install flake8
  flake8 mozregression tests

To run unit tests:

  pip install mock # not stricly required, but recommended to keep a clean dir
  python setup.py test

You could also use the coverage module to view the lines covered by tests:

  pip install coverage mock
  coverage run setup.py test
  coverage html # generate html results
  firefox htmlcov/index.html # see them in your favorite browser

== Issue / feature tracking ==

We track mozregression bugs and feature requests inside bugzilla, in the Testing / mozregression component.

<bugzilla>
    {
        "quicksearch": "status:new,assigned,reopened,unconfirmed",
        "product": "Testing",
        "component": "mozregression"
    }
</bugzilla>

== Submitting patches ==

If a bug is not open already corresponding to the bug you want to fix (or the feature you want to add), please file one. After that, please open a github pull request with your code change, and set a flag in bugzilla for it to be reviewed, as described here:

http://ateam-bootcamp.readthedocs.org/en/latest/guide/development_process.html#git-and-github

Please make sure your patch conforms to [https://www.python.org/dev/peps/pep-0008/ PEP8] before submitting it.