StackGuardian / StackGuardian/tirith

research(provider): `repo_metadata` — the input-document shape for live repo state

Open
#358 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

research
Dominant language
Python
Stars
165
Forks
42
Avg merge
1d 3h
Merged PRs (30d)
11

Description

The v1 slice (GitHub collector + predefined checks) is an R1 issue; this item keeps the
input-shape research and the multi-forge questions (GitLab, org/enterprise scope). Recommendation:
a keyed bag of GitHub REST API responses with field names validated against GitHub's published
OpenAPI — not the raw JSON of an existing repo-scoring scanner, which was evaluated and
rejected (feature-gated, schema drift against its own code, shipped field-name typos, repository
scope only). Adopt a 404-fallback convention so "branch not protected" is expressible with existing
conditions.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing GitHub's published OpenAPI for the REST responses needed by the GitHub collector, then compare the requirements with the GitLab and organization/enterprise questions in the issue. Define the keyed response bag and 404 fallback convention; done means the v1 input shape and multi-forge boundaries are documented and agreed.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, gitlab, openapi, python
Domain
backend-api-design, devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.