docs: flisk-sh/analytics has no SECURITY.md or CONTRIBUTING.md

Aperta Adatta ai principianti
#22 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
github
Ambito
documentation

Direzione di ricerca

Parti dalla radice del repository: leggi README e la configurazione dei test (per un repository JavaScript, gli script in package.json) per conoscere il comando di test esatto, poi scrivi SECURITY.md indicando a chi segnala di usare GitHub private vulnerability reporting e un CONTRIBUTING.md che copra configurazione, test, sign-off e dimensione delle PR. L'issue chiede anche controlli che questi file esistano e indichino una via di segnalazione e il comando di test, quindi guarda come sono organizzati i test esistenti prima di aggiungerli. Fatto significa che entrambi i file sono nella radice, che GitHub mostra i link Security policy e Contributing e che tutti i test passano.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

agents area: runtime automation chore cli consistency dependencies developer-experience difficulty: easy documentation enhancement good first issue help wanted hygiene json-output priority: P3 starters tests

Problem

flisk-sh/analytics has no SECURITY.md or CONTRIBUTING.md. A person who finds a vulnerability has no private way to report it and may open a public issue. A new contributor has no short guide to run the tests or open a pull request.

Root Cause Analysis

The repository root holds only code, a README and a license. GitHub shows no "Security policy" tab and no contributing link. Sibling repos learn and grow already track the same gap (docs: no CONTRIBUTING.md or SECURITY.md).

TDD Fix Plan

  1. RED: Add a check that the repo root contains SECURITY.md naming a private reporting address or the GitHub private advisory link.
    GREEN: Add SECURITY.md.
  2. RED: Add a check that CONTRIBUTING.md exists and names the test command.
    GREEN: Add a short CONTRIBUTING.md (setup, tests, sign-off, PR size).

REFACTOR: Share one template across org repos.

Acceptance Criteria

  • SECURITY.md explains how to report privately
  • CONTRIBUTING.md names the test command
  • GitHub shows the Security policy and Contributing links
  • All new tests pass
  • Existing tests still pass
Lingua principale
JavaScript
Stelle
0
Fork
2
Merge medio
1h 33m
PR unite (30g)
7

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di flisk-sh/analytics

Tutte le issue di flisk-sh/analytics

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.