Tutorial proposal: Best practices for being an ecosystem package

Aperta
#35 3 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Nell’issue non sono identificati file, test o punti di ingresso. Inizia individuando la struttura della documentazione del tutorial, quindi definisci una guida che tratti il template del package, il blocco delle versioni, le dipendenze non necessarie e le raccomandazioni per le API. Il lavoro è completato quando viene aggiunta la guida alle best practice per i package dell’ecosistema con questi argomenti trattati.

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

Descrizione

new-tutorial

There are often very non-obvious, but simple things that sometimes prevent ecosystem packages from "going mainstream". We should write a tutorial/guide on do's and don't's for building ecosystem packages.

I'm thinking here we can promote our template, but also make recommendations about requirements (don't pin versions, generally don't add unnecessary dependencies, etc etc), and some commentary on APIs.

Lingua principale
Python
Stelle
22
Fork
18
Merge medio
3h 9m
PR unite (30g)
9

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

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 scverse/scverse-tutorials

Tutte le issue di scverse/scverse-tutorials

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.