Docs hosted at https://everyinc.github.io/compound-engineering-plugin are not easily discoverable on GitHub

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

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

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

評価

難易度
1/5
見積もり時間
1時間未満
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
github
領域
documentation

調査の方向性

Update the repository’s GitHub About section to link to https://everyinc.github.io/compound-engineering-plugin. Start with the repository settings or the existing project metadata that controls its About section. Done when the docs link is visible from the repository landing page.

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

説明

documentation

Great plugin! Thanks so much for sharing.

Just wanted to note that it was not obvious from initial glance at this GitHub page how to navigate to the docs hosted at https://everyinc.github.io/compound-engineering-plugin.

I eventually found them by checking the recent deployment history, but I think adding this link to the About section on the repo, so it shows up clearly in the repo landing page, would be very useful!

E.g., like this!

Image
主要言語
TypeScript
スター
25.6k
フォーク
2.1k
平均マージ
3時間 57分
マージ済み PR(30日)
170

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

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

EveryInc/compound-engineering-plugin のほかの issue

EveryInc/compound-engineering-plugin の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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