IQSS / IQSS/dataverse-client-javascript

Create documentation for the installation and use of the package v2

Aperta
#73 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

pm.GREI-d-2.7.1 pm.GREI-d-2.7.2 Size: 33
Lingua principale
TypeScript
Stelle
20
Fork
11
Merge medio
2g 5h
PR unite (30g)
1

Descrizione

Overview of the feature request

This documentation should contain topics such as the installation of the package through NPM, the initialization via ApiConfig, and instructions for importing and executing its use cases.

What inspired the request?

  • Latest changes on the package and upcoming release

What existing behavior do you want changed?

None

Any brand new behavior do you want to add to js-dataverse?

None

Any open or closed issues related to this feature request?

None

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.

Direzione di ricerca

Iniziare esaminando il flusso di installazione NPM del package e l'inizializzazione di ApiConfig, quindi seguire il percorso documentato di importazione ed esecuzione dei casi d'uso. Il lavoro è completato quando la documentazione copre l'installazione, l'inizializzazione, l'importazione e l'esecuzione dei casi d'uso per il package v2.

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

Valutazione

Stack tecnologico
typescript
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.