Verify how-to: Cardano API

オープン 初心者向け
#344 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

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

評価

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

調査の方向性

website/docs/how-to-guide/advanced/cardano-api.mdから始め、クリーンなディレクトリで記載されているコマンドをそのまま実行します。すべてのコマンド、リンク、パッケージ、イメージタグ、バージョンを確認し、失敗や必要な修正を記録します。ページが正確で、知見が投稿され、#301の該当するチェックリスト項目が更新されていれば完了とします。

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

説明

documentation pinned

Part of the tutorial verification checklist in #301.

Page: website/docs/how-to-guide/advanced/cardano-api.md
Title on the site: Cardano API

How to follow along
  1. Open the page on the site and read it end to end before running anything.
  2. Work through it in a clean directory, as a new user. Do not skip setup steps because you already have the tooling; the point is to see what a newcomer sees.
  3. Run every command exactly as written, then compare the output with what the page claims it should be.
  4. Open every link, including links inside code comments and references.

Done when

  • Every command runs as written, or the page is updated so that it does
  • Every link resolves
  • Every package, image tag and version referenced still exists
  • The matching box in #301 is ticked and the findings are posted here
What to record when a step breaks
  • The exact command and the error text, copied rather than summarised
  • The heading or step number it sits under
  • What you changed to make it work

Commands the page asks you to run, in order:

source-repository-package
  type: git
  location: https://github.com/IntersectMBO/cardano-api.git
  tag: <version-tag>
主要言語
TypeScript
スター
13
フォーク
24
平均マージ
2日 3時間
マージ済み PR(30日)
16

環境構築

はじめの一歩

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

IntersectMBO/developer-experience のほかの issue

IntersectMBO/developer-experience の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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