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

Provide a Gradle plugin that applies REST Docs' configuration conventions

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

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
30/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
领域
build-system

调研方向

Start by reviewing the existing Gradle configuration for snippetsDir, the test task, and Asciidoctor. Determine how the spring-restdocs-asciidoctor extension, snippet input/output directories, and task dependency should be represented in a plugin. Done means the REST Docs conventions can be applied automatically without repeating the listed configuration.

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

描述

type: enhancement

When you use REST Docs with Gradle there are a few things that need to be configured:

  1. snippetsDir extra property
  2. Additional output directory on the test task that points to the snippets directory

When you're also using Asciidoctor the following also needs to be configured:

  1. spring-restdocs-asciidoctor extension
  2. Additional input directory on the asciidoctor task that points to the snippets directory
  3. A dependency on the test task from the asciidoctor task

This configuration could be encapsulated in a plugin that applies these conventions, or a variant of them, automatically.

主要语言
Java
星标
1.2k
派生
733
PR 合并指标
30 天内没有已合并 PR

环境准备

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

从这里开始

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

spring-projects/spring-restdocs 的其他 Issue

查看 spring-projects/spring-restdocs 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

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