IQSS / IQSS/dataverse-client-javascript

Create documentation for the installation and use of the package v2

オープン
#73 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

pm.GREI-d-2.7.1 pm.GREI-d-2.7.2 Size: 33
主要言語
TypeScript
スター
20
フォーク
11
平均マージ
2日 5時間
マージ済み PR(30日)
1

説明

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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まずパッケージの NPM インストールフローと ApiConfig の初期化を確認し、次に文書化されているインポートとユースケース実行の経路を追跡します。パッケージ v2 のインストール、初期化、インポート、ユースケースの実行がドキュメントでカバーされた時点で作業は完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
typescript
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。