OpenDevicePartnership / OpenDevicePartnership/OpenDevicePartnership.github.io

Dynamic Repository Diagrams

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

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

主要言語
Rust
スター
1
フォーク
10
平均マージ
5日 22時間
マージ済み PR(30日)
1

説明

The Projects landing page has 3 main links for P (Patina), EC, and ES (EC Services) which bring up a page with What, Why, Who, and a repository diagram.

This task covers improvements for those diagrams:

  1. Create an engine that auto-generates the diagram each time the user opens the page instead of relying on a user updated jpg. Maybe pull topics from each repo for determining how to use the URLs?
  2. Add text to the auto-generated diagram to explain what it is and how to read it. The text needs to be geared to a new engineer browsing the web site.
  3. Create an action in this repo that creates a bug if any repository is found that does not provide the necessary hooks for the diagram engine.

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

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

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

調査の方向性

Projects のランディングページと Patina、EC、EC Services へのリンクを調査し、現在のリポジトリ図がどのように提供されているかを追跡します。図のエンジン、新規参加者向けの説明テキスト、および必要なリポジトリ検証を定義します。ページへのアクセス時に図が生成され、自動化されたアクションによって必要なフックがないリポジトリが報告されれば完了です。

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

評価

技術スタック
github-actions, rust
領域
documentation, tooling
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

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

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