Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Document best practices when adding images to documentation

未关闭
#153 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
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
派生
48
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

oasisprotocol/docs 的其他 Issue

查看 oasisprotocol/docs 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。