Skip to content

Commit c63266a

Browse files
jdiegosierraclaude
andcommitted
docs: consolidate How It Works and Report Example sections
Merge the two overlapping sections into a single, more concise "How It Works" section that explains the process and shows the example report in one place. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent fe5476a commit c63266a

1 file changed

Lines changed: 10 additions & 16 deletions

File tree

README.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,14 @@ When a PR is opened, this action:
2323

2424
1. Fetches the contributor's GitHub activity from the past 12 months
2525
2. Evaluates each metric against configurable thresholds
26-
3. Generates a detailed report with metric breakdown and recommendations
27-
4. Posts the report as a PR comment (or labels/fails based on configuration)
26+
3. Generates a detailed report as a PR comment with:
27+
- ✅/❌ Overall status indicator
28+
- Individual metric results in a table format
29+
- Pass/fail status for each metric with thresholds
30+
- Personalized recommendations for improvement
31+
- Special handling for new accounts and limited data
2832

29-
> [!TIP] **See it in action:** Check out [PR #5](https://github.com/jdiegosierra/contributor-report/pull/5) for a live
30-
> example of the Contributor Report in action, showing the detailed analysis and report format.
31-
32-
## Report Example
33-
34-
The action posts a detailed comment on each PR with:
35-
36-
- ✅/❌ Overall status indicator
37-
- Individual metric results in a table format
38-
- Pass/fail status for each metric with thresholds
39-
- Personalized recommendations for improvement
40-
- Special handling for new accounts and limited data
41-
42-
Example report:
33+
**Example report:**
4334

4435
```markdown
4536
## ✅ Contributor Report
@@ -64,6 +55,9 @@ Example report:
6455
- Consider reviewing code from other contributors to build reputation
6556
```
6657

58+
> [!TIP] **See it in action:** Check out [PR #5](https://github.com/jdiegosierra/contributor-report/pull/5) for a live
59+
> example of the Contributor Report in action.
60+
6761
## Why Reports Instead of Scores?
6862

6963
Some tools assign contributors a single numeric score (e.g., "45/100" or "Safe/Caution" badges). While this seems

0 commit comments

Comments
 (0)