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

Improve docs in Factories

Aperta Adatta ai principianti
#161 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

@pollychen-lab ci sta già lavorando.

Dal 30/9/2026.

  • #162 di @pollychen-lab — aperta

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
82/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
rust
Ambito
documentation

Direzione di ricerca

Inizia dalla documentazione delle factory per l’entry point bouncycastle-factory, quindi confronta la documentazione delle primitive in bouncycastle-core::traits. Aggiungi dalla documentazione di ogni factory dei link alla documentazione della primitiva corrispondente e conferma che ogni factory fornisca questa navigazione agli utenti IDE.

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

Descrizione

documentation good first issue help wanted

If a user starts with bouncycastle-factory as their entry-point to the library, the docs are rather thin. At a minimum, the docs in each factory should link back to the textbook-y docs about that primitive in bouncycastle-core::traits. This is particularly relevant if a user is using exclusively factories, because those are the docs that they will see in their mouse-over popup in their IDE.

Lingua principale
Rust
Stelle
25
Fork
18
Merge medio
14g 10h
PR unite (30g)
5

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 bcgit/bc-rust

Tutte le issue di bcgit/bc-rust

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.