IQSS / IQSS/dataverse-client-javascript

Create documentation for the installation and use of the package v2

Ouverte
#73 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

pm.GREI-d-2.7.1 pm.GREI-d-2.7.2 Size: 33
Langage dominant
TypeScript
Étoiles
20
Forks
11
Merge moyen
2 j 5 h
PR mergées (30 j)
1

Description

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par examiner le flux d’installation NPM du package et l’initialisation de ApiConfig, puis suivez le parcours documenté d’importation et d’exécution des cas d’utilisation. Le travail est terminé lorsque la documentation couvre l’installation, l’initialisation, l’importation et l’exécution des cas d’utilisation pour le package v2.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
typescript
Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.