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

Design Notes need to be formalized as specifications

Aperta
#346 1 commento 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
48/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Start by locating the design notes in the repository and reading them to identify which documents need migration; the issue does not name specific files or a target specification format. Keep the original notes somewhere deep in the repository for history, and rewrite the design documents so they read as human-readable specifications. Done when the migrated documents read as specifications rather than records of decisions.

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

Descrizione

area:docs in-progress
Area

core:docs

What

Design notes read as a bunch of decisions and are totally unreadable by humans. This should be formalized as a specification. Keep the notes for history somewhere deep in the repo, but make these documents human readable as specifications

Done when

Design notes should be migrated to a format that reads like a specification rather than a long document of decisions

Lingua principale
Python
Stelle
205
Fork
17
Merge medio
3h 49m
PR unite (30g)
89

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

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 txoof/PaperPi

Tutte le issue di txoof/PaperPi

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.