Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Real case: Quillgrain and Quillgrain_Common — show the CLI result and make reporting routes true

Aperta
  • Qualcosa non va?
#83 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
powershell, python
Ambito
cli, documentation, release, security

Direzione di ricerca

Read Quillgrain's README, SECURITY.md, pyproject.toml and CHANGELOG, then inspect Quillgrain_Common's README and .github/workflows/validate.yml. Run the documented commands in a fresh virtual environment and capture qg check output, including the missing context file case. Verify the reporting route through the API and record both repositories' before and after SHAs plus the tool SHA; document that voice quality needs human review in case-studies/quillgrain.md.

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

Descrizione

real-case

Targets: drevendev/Quillgrain at 3b928fad948a6bd4e069e68a7255bc7996853516 and drevendev/Quillgrain_Common at 1f244f9983cee0c838ad42969bdcdbfc6195275e (both MIT). Two project types: a CLI and a data pack.

Before (observed 2026-10-22)

  • Quillgrain README:9-17 gives PowerShell-only commands and doesn't show what qg check outputs. POSIX gets one line.
  • SECURITY.md:3-4 relies on GitHub private vulnerability reporting, which the API reports as disabled for the repository.
  • pyproject.toml and CHANGELOG say 0.1.0rc1, but there is no tag or release. There are no topics.
  • Quillgrain_Common's README says "after installing the pinned engine described in CI". The pin exists only in .github/workflows/validate.yml. Its build example omits the --public flag that CI uses; confirm which is intended.

Planned after (PRs in both repositories)

  • Add POSIX and PowerShell blocks and a trimmed real qg check output captured at a named SHA.
  • Enable private reporting, or reword SECURITY to a route that exists.
  • Publish a v0.1.0rc1 pre-release from the CHANGELOG.
  • Give Common a copyable pinned engine install and resolve the --public difference.

Acceptance

  • Before/after SHAs for both repositories and the tool SHA are recorded.
  • A fresh-venv run of the README commands records observed output, plus one failure case (a missing context file).
  • Private reporting status is verified through the API after the change.
  • case-studies/quillgrain.md says that voice quality wasn't validated and needs human review.

Related: #32. Follows #80

Lingua principale
Python
Stelle
2
Fork
0
Merge medio
7h 30m
PR unite (30g)
78

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 drevendev/BeautifulRepo

Tutte le issue di drevendev/BeautifulRepo

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.