README.md

Reqstool Java Annotations

Java annotations for reqstool requirements traceability.

Overview

Provides @Requirements and @SVCs annotations for linking Java code to requirements and software verification cases. Used together with the Maven Plugin or Gradle Plugin.

Installation

Add the dependency to your project:

Maven

<dependency>
    <groupId>io.github.reqstool</groupId>
    <artifactId>reqstool-java-annotations</artifactId>
    <version>1.0.0</version>
</dependency>

Gradle

implementation 'io.github.reqstool:reqstool-java-annotations:1.0.0'

Usage

import io.github.reqstool.annotations.Requirements;
import io.github.reqstool.annotations.SVCs;

@Requirements({"REQ_001", "REQ_002"})
public class MyService {
    // Implementation
}

@Test
@SVCs("SVC_001")
public void testMyService() {
    // Test
}

Documentation

Full documentation can be found here.

Contributing

See the organization-wide CONTRIBUTING.md.

License

MIT License.