Skip to content

Commit a527e73

Browse files
committed
Updated feature list
1 parent 02003a2 commit a527e73

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,36 @@
11
# commit-features
22
A python package for extracting commit features
3+
4+
## Features
5+
6+
|Columns |Type|Description |
7+
|--------------------|----|-------------------------------------------------------------------------------------------|
8+
|repo |str |Repository link |
9+
|sha |str |Target Commit SHA |
10+
|message |str |Associated commit message |
11+
|file_name |str |Name of file altered in patch |
12+
|file_number |int |File number in patch |
13+
|file_extension |str |File extension |
14+
|total_files_changed |int |Number of files changed at commit |
15+
|raw_file_patch |str |The raw patch for the entire file |
16+
|patch_number |int |Patch instance |
17+
|total_patches |int |Total number of patches per file |
18+
|raw_patch_header |str |Header of the patch (@@ -A,X +B,Y @@) |
19+
|raw_patch |str |The raw patch for a single patch |
20+
|original_code |str |The lef side (parent commit state) of the git diff in GitHub. Raw code. -'s are stripped. |
21+
|original_line_start |int |Original line start number (@@ -**A**,X +B,Y @@) |
22+
|original_line_length|int |Original line end (@@ -A,**X** +B,Y @@) |
23+
|original_line_end |int |Original_line_start + original_line_length |
24+
|modified_code |str |The right side (target commit state) of the git diff in GitHub. Raw code. +'s are stripped.|
25+
|modified_line_start |int |Modified line start number (@@ -A,X +**B**,Y @@) |
26+
|modified_line_length|int |Modified line end (@@ -A,X +B,**Y** @@) |
27+
|modified_line_end |int |Modified_line_start + modified_line_length |
28+
|additions |int |Added lines count in a patch |
29+
|added_code |str |Raw code added during patch |
30+
|deletions |int |Deleted lines count in a patch |
31+
|deleted_code |str |Raw code deleted during patch |
32+
|changes |int |additions + deletions |
33+
|status |str |GitHub status tag at file level (e.g., modified) |
34+
|total_additions |int |Total lines added for a file |
35+
|total_deletions |int |Total lines deleted for a file |
36+
|total_changes |int |Total lines changed for a file (total_additions + total_deletions)

0 commit comments

Comments
 (0)