Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Document best practices when adding images to documentation

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

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
説明が足りない
活発さ
停滞
領域
cli, documentation

調査の方向性

ファイル、テスト、CLIエントリポイントは指定されていないため、まず画像に関するドキュメントのセクションと、既存の画像サイズ削減ツールを探します。完了の条件は、ドキュメントでフォーマットの選択、サイズの削減、pre-commitの使用、命名を扱い、要求されたCLIコマンドの動作と使用方法が明確に文書化されていることです。

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

説明

images

Some obvious steps would be:

  1. Document how to choose an appropriate image format (JPG, PNG).
  2. Add CLI command that automatically reduces size of images.
  3. Document how to apply it before adding images to git history.
  4. Document how to sensibly name images.
主要言語
TypeScript
スター
15
フォーク
46
平均マージ
1日 21時間
マージ済み PR(30日)
1

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

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

はじめの一歩

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

oasisprotocol/docs のほかの issue

oasisprotocol/docs の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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