From 3cfbd358223163492f6e0f9e3485ff73765983c2 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 4 Mar 2026 20:56:53 +0000 Subject: [PATCH 1/2] Initial plan From 3acf63f2851f0b83195a80030138fb954614fc6a Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 4 Mar 2026 20:59:44 +0000 Subject: [PATCH 2/2] Document optional Version root element in README.md and copilot instructions Co-authored-by: Mehtrick <4493019+Mehtrick@users.noreply.github.com> --- .github/copilot-instructions.md | 3 +++ README.md | 8 ++++++++ 2 files changed, 11 insertions(+) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index ead35eb..35d190d 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -59,6 +59,7 @@ src/main/resources/ ```yaml Feature: Description of the feature +Version: "1.0.0" Reference: "[TICKET-123](https://example.com/TICKET-123)" Background: @@ -85,6 +86,8 @@ Scenarios: - Other assertion ``` +The optional `Version` field specifies the version of the spec. In generated Java it becomes a `@version` Javadoc tag; in generated AsciiDoc it is rendered as `Version: ` below the feature title. + The optional `Reference` field links a spec to an external ticket or resource. It accepts plain text or a Markdown link `[text](url)`. In generated Java it becomes a `@see` Javadoc tag; in generated AsciiDoc it is rendered as a hyperlink below the feature title. ## Code Generation Process diff --git a/README.md b/README.md index 4c7a550..91be678 100755 --- a/README.md +++ b/README.md @@ -64,6 +64,7 @@ You will find the typical BDD keywords in it. For more convenience there is a [V `example.zgr` ```yaml Feature: Test eines KassenAutomaten +Version: "1.0.0" Reference: "[TICKET-123](https://example.com/TICKET-123)" Background: Given: @@ -92,6 +93,10 @@ Scenarios: ``` +The optional `Version` field specifies the version of the spec: +- In generated Java: rendered as a `@version` Javadoc tag on the abstract class. +- In generated docs: rendered as `Version: ` below the feature title. + The optional `Reference` field links a spec to an external ticket or resource. It accepts plain text or a Markdown link `[text](url)`: - In generated Java: rendered as a `@see text` Javadoc tag on the abstract class. - In generated docs: rendered as an AsciiDoc hyperlink (`link:url[text]`) below the feature title. @@ -110,6 +115,7 @@ import org.junit.Test; /** * Test eines KassenAutomaten + * @version 1.0.0 * @see TICKET-123 */ public abstract class AbstractTestEinesKassenautomaten extends AbstractTestclass implements TestEinesKassenautomatenInterface { /** @@ -180,6 +186,8 @@ public interface TestEinesKassenautomatenInterface { = Test Foo :toc: +Version: 1.0.0 + Reference: link:https://example.com/TICKET-123[TICKET-123] == Background