grading-on-a-curve/code/examples/FindBugFixes.md

Find bugfixes from issues and a gitlog.json

To link bugfixes to issues one can use the find_bug_fixes.py script. This script uses the results from the fetch.py and the git_log_to_array.py scripts. Using the results from previous examples in Fetch and GitLogToArray, one can produce the data necessary for running the SZZ algorithm.

Start by locating the issues directory, the one produced in the Fetch example. This directory must contain at least one res<0...>.json.

Second, locate the gitlog.json that was produced in the GitLogToArray example. Then provide these to the find_bug_fixes.py script.

Lastly, identify how a bug fix looks like in a commit. The matching string for the Jenkins project looks like:

pattern = r'JENKINS-{nbr}\D|#{nbr}\D|HUDSON-{nbr}\D'

The script will try to find the pattern in each commit and then decide if it's a fixing commit or not.

python find_bug_fixes.py --gitlog <path_to_gitlog>/gitlog.json --issue-list <path_to_issues>/issues --gitlog-pattern "<fix_pattern>"

In this example, one can use the results in examples/data directory.

Finally, when the script is done the results are found in the issue_list.json. An example of that file is found on issue_list.json.