diff --git a/README.md b/README.md index 1a51884e..aa7f31fe 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [![Task Status](https://github.taskcluster.net/v1/repository/mozilla/bugbug/master/badge.svg)](https://github.taskcluster.net/v1/repository/mozilla/bugbug/master/badge.svg) + ## Classifiers - **assignee** - The aim of this classifier is to suggest an appropriate assignee for a bug. @@ -38,12 +39,17 @@ Run `pip install -r requirements.txt` and `pip install -r test-requirements.txt` +### Auto-formatting + +This project is using [pre-commit](https://pre-commit.com/). Please run `pre-commit install` to install the git pre-commit hooks on your clone. + +Every time you will try to commit, pre-commit will run checks on your files to make sure they follow our style standards and they aren't affected by some simple issues. If the checks fail, pre-commit won't let you commit. + ## Usage Run the `run.py` script to perform training / classification. The first time `run.py` is executed, the `--train` argument should be used to automatically download databases containing bugs and commits data. - ### Running the repository mining script 1. Clone https://hg.mozilla.org/mozilla-central/. @@ -73,9 +79,3 @@ Note: the script will take a long time to run (on my laptop more than 7 hours). - `bugbug/nlp` contains utility functions for NLP; - `bugbug/labels.py` contains utility functions for handling labels; - `bugbug/bug_snapshot.py` contains a module to play back the history of a bug. - -## Auto-formatting setup - -This project is using [pre-commit](https://pre-commit.com/). Please run `pre-commit install` to install the git pre-commit hooks on your clone. - -Then every time you will try to commit, it will check that the files are correctly formatted before letting you commit.