bugbug/README.md

# bugbug

## Classifiers
- **bug vs feature** - Bugs on Bugzilla aren't always bugs. Sometimes they are feature requests, refactorings, and so on. The aim of this classifier is to distinguish between bugs that are actually bugs and bugs that aren't. The dataset currently contains 2110 bugs, the accuracy of the current classifier is ~93% (precision ~95%, recall ~94%).

- **regression vs non-regression** - Bugzilla has a `regression` keyword to identify bugs that are regressions. Unfortunately it isn't used consistently. The aim of this classifier is to detect bugs that are regressions.

- **tracking** - The aim of this classifier is to detect bugs to track.


## Setup

Run `pip install -r requirements.txt` and `pip install -r test-requirements.txt`

If you update the bugs database, run `xz -v9 -k data/bugs.json`.
If you update the commits database, run `xz -v9 -k data/commits.json`.
Update documentation to match what the project became 2018-12-05 18:25:13 +03:00			`# bugbug`
First commit Former-commit-id: 37f2820f781ae0e6719cf7677e90c0a189f026e0 2018-03-11 23:12:35 +03:00
Update documentation to match what the project became 2018-12-05 18:25:13 +03:00			`## Classifiers`
			`- bug vs feature - Bugs on Bugzilla aren't always bugs. Sometimes they are feature requests, refactorings, and so on. The aim of this classifier is to distinguish between bugs that are actually bugs and bugs that aren't. The dataset currently contains 2110 bugs, the accuracy of the current classifier is ~93% (precision ~95%, recall ~94%).`

			- regression vs non-regression - Bugzilla has a `regression` keyword to identify bugs that are regressions. Unfortunately it isn't used consistently. The aim of this classifier is to detect bugs that are regressions.

			`- tracking - The aim of this classifier is to detect bugs to track.`
First commit Former-commit-id: 37f2820f781ae0e6719cf7677e90c0a189f026e0 2018-03-11 23:12:35 +03:00
Use MongoDB to store bugs Former-commit-id: c9e742744e960fe9afab609fa3c52833ebc1810b 2018-09-21 18:11:34 +03:00
			`## Setup`

Update setup steps 2018-11-20 19:24:02 +03:00			Run `pip install -r requirements.txt` and `pip install -r test-requirements.txt`
Use MongoDB to store bugs Former-commit-id: c9e742744e960fe9afab609fa3c52833ebc1810b 2018-09-21 18:11:34 +03:00
Remove data files from the repo and host them on another service Former-commit-id: db43a17445659d664fc41c014e9fe2d61c98b4ba 2018-11-20 12:36:04 +03:00			If you update the bugs database, run `xz -v9 -k data/bugs.json`.
			If you update the commits database, run `xz -v9 -k data/commits.json`.