Imoprove the docs for Hackbot

Aperta
#6,729 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Attiva
Ambito
documentation

Direzione di ricerca

La issue identifica la documentazione di Hackbot come obiettivo, ma non indica file, test o punti di ingresso. Per prima cosa individua la documentazione esistente di Hackbot, poi rimuovi i dettagli di implementazione e rendi più chiara e concisa la spiegazione ad alto livello; il lavoro è completato quando il risultato è conciso e ha meno probabilità di diventare obsoleto.

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

Descrizione

hackbot

We should drop implementation details and keep high-level concepts and things that are not easy to grasp quickly. This includes making it more concise.

Ideally, improvements should not make the docs outdated frequently; that is a sign that we are documenting too many implementation details or documenting something that is not mature yet.

Lingua principale
Python
Stelle
570
Fork
351
Merge medio
2g 11h
PR unite (30g)
61

Guida per i contributori

Apri la 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 mozilla/bugbug

Tutte le issue di mozilla/bugbug

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.