Providing entire file github url in docs
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 35/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- javascript
調査の方向性
ember app が生成されたドキュメント用の GitHub URL をどのように構築するかを、外部依存関係のパス node_modules/rsvp/index.js と、対応する inflector のケースから調査します。生成されたドキュメントに、これらの依存関係について完全で機能する GitHub URL が含まれていることを検証し、アプリがそれらを計算する必要がなくなるようにします。
索引モデルが issue の本文から書いたものです。
説明
At present in the ember app we construct the github url of a file by checking its project name and the appending the partial file url from the docs we generate. This doesn't handle scenarios where the docs refers to classes such as rsvp, inflector which are ember libraries that are external dependencies for ember & ember-data. In such cases the file url is defined as node_modules/rsvp/index.js which will be broken when user accesses it.
We should handle these scenarios & update the docs with a full & functional github url so that the ember app can just provide the link to the user without any computation at its end.
- 主要言語
- JavaScript
- スター
- 10
- フォーク
- 11
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
ember-learn/ember-jsonapi-docs のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 42/100
ember-learn/ember-jsonapi-docs#141 · コメント 2 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 40/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
-
Bug - Parsing of new decorators doesn't work再び着手できるかも @pzuraq が 2541 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
ember-learn/ember-jsonapi-docs#75 · コメント 11 件 · 担当者 2 名 ·
ember-learn/ember-jsonapi-docs の issue をすべて見る
似ている issue
-
Access-request approve silently discards the decider's note (decision_note written only on deny)オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
Uuriko/project-room#3378 ·
メンテナーはふだん 1 日以内に返信
-
Notifications pagination accepts NaN and negative LIMIT/OFFSET対応中かも @Senthil455 が今日担当しました。 オープンBUGS MEDIUM
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
elixpo/blogs.elixpo#419 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
immich-app/immich#32426 ·
メンテナーはふだん 1 日以内に返信