docs: add a README to @relkit/client

オープン 初心者向け
  • 何か問題がありますか？
#177 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
79/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
bun, typescript
領域
documentation

調査の方向性

WRITING.mdを読み、既存のクライアントパッケージのファイルを調べて、型付きクライアントとそのAPIリファレンスの構成を把握します。短い説明、api.orders.listの例、relkit.devのクライアントガイドへのリンクを含むpackages/client/README.mdを追加します。bun run checkを実行します。チェックが成功し、ドキュメントページに追加した例があれば型チェックを通ることを完了条件とします。

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

説明

documentation good first issue

packages/client has no README.md, so its npm page is empty.

What to do

  • Add packages/client/README.md: what the typed client is, one short example of calling an API
    reference such as api.orders.list, and links to the client guide on https://relkit.dev.
  • Follow WRITING.md (plain language, one product name).

Done when bun run check passes and the example type-checks if you add it to a docs page too.

主要言語
TypeScript
スター
1
フォーク
0
平均マージ
2時間 45分
マージ済み PR（30日）
64

環境構築

はじめの一歩

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

rel-kit/relkit のほかの issue

rel-kit/relkit の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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