Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,20 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: apache-2.0
|
| 3 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: apache-2.0
|
| 3 |
+
---
|
| 4 |
+
|
| 5 |
+
A description of the fields:
|
| 6 |
+
|
| 7 |
+
| Column | What it captures | Typical values |
|
| 8 |
+
| ----------------------- | --------------------------------------------- | ------------------------- |
|
| 9 |
+
| `id` | Row identifier | 1-100 |
|
| 10 |
+
| `repo_name` | Example repository label | `repo_14` |
|
| 11 |
+
| `file_path` | Path + filename with extension | `src/utils/parsefile.py` |
|
| 12 |
+
| `language` | Programming language | Python, Java… |
|
| 13 |
+
| `function_name` | Target symbol that was reviewed | `validateSession` |
|
| 14 |
+
| `annotation_summary` | Free-text note written by the annotator | “Added input validation…” |
|
| 15 |
+
| `potential_bug` | Did the annotator flag a likely bug? (Yes/No) | |
|
| 16 |
+
| `test_cases_written` | Number of unit-tests already present | 0-25 |
|
| 17 |
+
| `readability_rating` | 1 (poor) – 5 (excellent) | |
|
| 18 |
+
| `docstring_quality` | 1 (weak) – 5 (strong) | |
|
| 19 |
+
| `cyclomatic_complexity` | Simple complexity estimate (1-15) | |
|
| 20 |
+
| `topic_tags` | Semicolon-separated topical tags | `security;dp;testing` |
|