Improve Documentation

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

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
25/100
Issue 类型
文档
描述清晰度
需要澄清
活跃度
停滞
技术栈
openapi, ruby
领域
api, documentation

调研方向

The issue names no files, classes or methods, so first ask the maintainer which public APIs and configuration options should be covered. Then read the README and the gem's public entry points to find what is currently undocumented. Done means each chosen public API and option has a documented usage example that a newcomer can follow.

由索引模型根据 Issue 内容生成。

描述

enhancement help wanted

There are quite a few ways to use this library and options to configure. I need some help to document the public APIs.

主要语言
Ruby
星标
222
派生
27
平均合并
17 小时 15 分钟
30 天内合并 PR
6

环境准备

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 没有贡献指南

从这里开始

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

ahx/openapi_first 的其他 Issue

查看 ahx/openapi_first 的全部 Issue

相似的 Issue

更多 Ruby Issue

把新 issue 发到你的邮箱

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