issues/README.md

# PR and issue event streams

Individually timestamped events for pull requests and issues, one JSON object per line, one file per object.

## Layout

```text
owner/repository/<number>.jsonl
events.parquet
commits.parquet
```

Each line of a `.jsonl` file holds exactly three fields, and lines are sorted by ascending `time`.

```json
{"time": "<ISO-8601 UTC>", "type": "<event type>", "payload": <raw fragment JSON>}
```

The payload is the raw GitHub REST fragment with no value removed, mutated, or added. Both `time` and `type` live only on the outer line, and `time` is never null.

## Temporal-use contract

The store is raw and unfiltered, so a consumer enforces a case `cutoff` itself. Two steps are needed. Filter the events to those with `time` strictly earlier than the cutoff, and pin the Git repository to its state at or before it.

Filtering by `time` is sufficient for every event except one, described next.

## The head event is an end-state snapshot

Each object emits a single `pr` or `issue` head event dated to its `created_at`, but the payload is the final snapshot of that object. Its mutable fields, among them `state`, `updated_at`, `closed_at`, `merged_at`, `merge_commit_sha`, labels, and the final counts, may describe moments after `created_at` and must not be read as known at `time`.

For time-accurate state transitions use the atomic `timeline:*` events such as `closed`, `merged`, and `labeled`. Every payload other than the head event is point-in-time.

## Event types

Pull requests emit `pr` from `created_at`, `commit` from `commit.author.date`, `review` from `submitted_at`, `review_comment` and `comment` from `created_at`, `review_request` per requested user and team, and `timeline:<event>`.

Issues emit `issue` from `created_at`, `comment` from `created_at`, and `timeline:<event>`.

Timeline events are dated by `created_at`, except `committed` from `author.date`
and `reviewed` from `submitted_at`, which carry their time nested. A `review_request` user or team is dated by the earliest matching timeline `review_requested` event, falling back to the head object's `created_at` when no match exists.