Merge pull request #32 from matks/better-doc

Improve documentation
PrestaShop · Mar 31, 2022 · a35dcff · a35dcff
2 parents 8827d0f + 108b106
commit a35dcff
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/doc/pr-waiting-review-snapshot.md b/doc/pr-waiting-review-snapshot.md
@@ -16,3 +16,9 @@ Collection is done every hour because this is a snapshot. Each data collection e
 ## Display
 
 All PRs are displayed on a web page.
+
+At the top total numbers are displayed.
+
+Then are displayed PRs never reviewed. Down are displayed PRs, the ones which have not been reviewed for a long time first.
+
+Each PR provides 3 information: how long since last review, how long since last commit, is that a PR from the maintainer team.
diff --git a/doc/review-daily-stats.md b/doc/review-daily-stats.md
@@ -37,3 +37,5 @@ First block is a view of the last 7 days, columns are days, rows are maintainers
 Second block is the next 23 days, columns are maintainers, rows are days.
 
 You can click on a maintainer name to see the details of collected review data.
+
+Badges help monitoring numbers. If a maintainer reviewed some PRs during the week-end they are displayed, else they are not (week-end are supposed to be off :D.