Documentation: Add docs/author_statistics.md #85

jnareb · 2024-12-29T22:10:42Z

This new documentation file is referenced from README.md, from docs/contributors_graph.md and added to the generated documentation at https://ncusi.github.io/PatchScope/

It describes various plots generated by the Author Statistics app (src/diffinsights_web/apps/author.py), the demo of which is also available at https://patchscope-9d05e7f15fec.herokuapp.com/author.

This new documentation is linked from README.md, and should also be linked from the generated documentation available in 'usage' tab at https://ncusi.github.io/PatchScope

This new subsection includes some discussion about the resampling period, but does not describe changing the aggregation function. There is comparison with similar plot on GitHub.

It describes both value (e.g. 'type.code') and percentage plots (e.g. 'type.code [%]'), and provides example figures for both. This subsection, like the previous one, does not describe changing the aggregation function.

This section includes more detailed analysis of patch size components, i.e. detecting the _number_ of removed, modified, and added lines. TODO: add link from contributors_graph.md back to author_statistics.md.

This subsection includes comparison to per-author plots in GitHub Insights and in the Contributors Graph app. TODO: add relevant screenshot from Contributors Graph app.

…cs.md There is only a skeleton with **TODO** for "Histogram of -/+ counts per resample period, for author" subsection.

This section includes comparison with and description of the heatmap of contributions from GitHub author profile page. TODO: Add similar plot from src/diffinsights_web/apps/contributors.py

What is nice is that we were able to find three examples of different periodicity of authorship behavior among different repositories and different authors.

…stics.md)

These plots are either the same plot, part of the plot (additions vs added and deleted lines), or related/similar plots (heatmap of line types logscale vs %).

Currently, these are very basic references, without linking into appropriate subsection, and without describing what extra information is there under the link.

dagshub · 2024-12-29T22:10:45Z

Join the discussion on DagsHub!

github-actions · 2024-12-29T22:11:18Z

Coverage Report

File	Stmts	Miss	Cover	Missing
src/diffannotator
__init__.py	0	0	100%
annotate.py	823	134	83%	52, 75–76, 85, 92, 101–104, 106–108, 110, 368–369, 373–374, 376, 413, 415–417, 419, 421–423, 425–426, 428–430, 528, 531, 534–535, 577, 727, 756, 799–801, 805, 836, 914, 1149, 1163–1166, 1168, 1172–1175, 1177, 1354, 1357, 1526, 1528, 1565, 1582–1583, 1669, 1672, 1784–1785, 1787, 1804, 1846–1847, 1863, 1878, 1893–1894, 1925, 1988, 1999, 2025, 2035, 2037, 2046–2050, 2054–2058, 2060, 2086, 2173, 2187, 2189–2190, 2192–2194, 2196, 2198–2200, 2202–2203, 2205, 2207, 2221, 2224, 2239–2241, 2247, 2260, 2269, 2277, 2280, 2350, 2356, 2358–2359, 2372, 2381–2386, 2500–2501, 2504–2505, 2509, 2554
config.py	50	7	86%	52–56, 58, 93
gather_data.py	344	53	84%	61, 87, 91, 93, 101, 106, 108, 121, 129, 161, 228–229, 232–233, 236, 239, 248, 259–265, 288–289, 309–310, 325, 343, 365–366, 531, 535, 568, 696, 709, 711, 714, 718, 720, 758, 784–785, 838, 890, 1076, 1108–1112, 1116
generate_patches.py	38	3	92%	102, 104, 126
languages.py	101	16	84%	170, 173, 176, 179, 182, 186, 217–218, 230, 249, 261, 263–264, 267, 273, 311
lexer.py	29	2	93%	87–88
src/diffannotator/utils
__init__.py	0	0	100%
git.py	487	85	82%	107, 233, 316, 318, 321–322, 324, 326–329, 331–333, 335–337, 342–343, 347, 349–350, 354–356, 358–359, 361–362, 364–365, 367, 475–476, 479, 516, 526, 529–531, 537, 568, 572, 579, 603, 616, 671, 753, 800, 807, 837, 841, 845, 885, 887, 898, 903, 908, 999–1000, 1047–1049, 1052–1053, 1087, 1091, 1157, 1162, 1164, 1167–1168, 1170, 1229–1230, 1344, 1346, 1369–1370, 1382, 1384, 1396–1397, 1431, 1445
TOTAL	1872	300	83%

Tests	Skipped	Failures	Errors	Time
79	5 💤	0 ❌	0 🔥	10.331s ⏱️

jnareb added 11 commits December 27, 2024 21:11

docs: Add initial version of docs/author_statistics.md

637683b

This new documentation is linked from README.md, and should also be linked from the generated documentation available in 'usage' tab at https://ncusi.github.io/PatchScope

docs: Add "Code frequency over time" subsection to author_statistics.md

2fc33b0

This new subsection includes some discussion about the resampling period, but does not describe changing the aggregation function. There is comparison with similar plot on GitHub.

docs: Add "Patch size components..." subsection to author_statistics.md

223697c

This section includes more detailed analysis of patch size components, i.e. detecting the _number_ of removed, modified, and added lines. TODO: add link from contributors_graph.md back to author_statistics.md.

docs: Add "Commit counts..." subsection to author_statistics.md

312207b

This subsection includes comparison to per-author plots in GitHub Insights and in the Contributors Graph app. TODO: add relevant screenshot from Contributors Graph app.

docs: Add "Histogram of -/+ counts..." subsections to author_statisti…

42bea25

…cs.md There is only a skeleton with **TODO** for "Histogram of -/+ counts per resample period, for author" subsection.

docs: Add "Line types heatmap ±" subsection to author_statistics.md

1a0babb

This section includes comparison with and description of the heatmap of contributions from GitHub author profile page. TODO: Add similar plot from src/diffinsights_web/apps/contributors.py

docs: Add "Periodic behavior..." subsection to author_statistics.md

bf284d8

What is nice is that we were able to find three examples of different periodicity of authorship behavior among different repositories and different authors.

docs: Sometimes per-author plots are not scaled to repo (author_stati…

1e2bfb9

…stics.md)

docs: Add plots from 'contributions' to author_statistics.md

f74cab3

These plots are either the same plot, part of the plot (additions vs added and deleted lines), or related/similar plots (heatmap of line types logscale vs %).

docs: Reference author_statistics.md in contributors_graph.md

e7b4b50

Currently, these are very basic references, without linking into appropriate subsection, and without describing what extra information is there under the link.

jnareb added the documentation Improvements or additions to documentation label Dec 29, 2024

jnareb self-assigned this Dec 29, 2024

docs/assets: Optimize images (using FileOptimizer)

49bf54e

jnareb merged commit 99863cb into main Dec 30, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation: Add docs/author_statistics.md #85

Documentation: Add docs/author_statistics.md #85

jnareb commented Dec 29, 2024

dagshub bot commented Dec 29, 2024

github-actions bot commented Dec 29, 2024 •

edited

Loading

Documentation: Add docs/author_statistics.md #85

Documentation: Add docs/author_statistics.md #85

Conversation

jnareb commented Dec 29, 2024

dagshub bot commented Dec 29, 2024

github-actions bot commented Dec 29, 2024 • edited Loading

github-actions bot commented Dec 29, 2024 •

edited

Loading