Skip to content

Commit b700538

Browse files
committed
update docs
1 parent 816f22b commit b700538

5 files changed

Lines changed: 170 additions & 246 deletions

File tree

README.md

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -158,31 +158,3 @@ Optional flags:
158158
| `-output` | `dist` | Output directory |
159159
| `-timeout` | `300s` | API timeout |
160160
| `-card` | `true` | Generate SVG cards |
161-
162-
---
163-
164-
## Architecture
165-
166-
Footprint is a pipeline, not a badge service. The same scoring engine that populates `report.json` drives the card. Nothing is computed at render time.
167-
168-
```
169-
fetch → classify → score → aggregate → render → write
170-
```
171-
172-
**Pipeline laws enforced in code:**
173-
174-
- `logic/aggregator.go` owns all score multiplication. Renderers and fetchers never compute scores.
175-
- Renderers consume finalized output models only — no re-derivation.
176-
- `DecideLayout` is a pure function: same inputs always produce the same geometry.
177-
- Decay ordering is deterministic: events are sorted chronologically before decay is applied, with URL as a stable tiebreaker.
178-
179-
**Fetch sources** (all via GitHub GraphQL):
180-
181-
- PRs authored (`author:<user> -user:<user> type:pr`)
182-
- PRs reviewed (`reviewer:<user> -user:<user> type:pr`)
183-
- Issues authored (`author:<user> -user:<user> type:issue`)
184-
- Issue comments (`user.issueComments`, paginated, private repos excluded)
185-
186-
---
187-
188-
Contributions welcome. See [CONTRIBUTING.md](CONTRIBUTING.md).

0 commit comments

Comments
 (0)