Skip to content

Commit 3a2c5d6

Browse files
author
Jimisola Laursen
committed
docs: documentation overhaul
- Standardize README.md with consistent badges and structure - Add CONTRIBUTING.md with repo-specific dev setup - Add/update Antora docs structure - Remove per-repo GitHub Pages workflow - Point documentation badge to central site Signed-off-by: jimisola <jimisola@jimisola.com>
1 parent f1313cd commit 3a2c5d6

5 files changed

Lines changed: 87 additions & 54 deletions

File tree

‎.github/workflows/publish_pages.yml‎

Lines changed: 0 additions & 47 deletions
This file was deleted.

‎CONTRIBUTING.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing to reqstool-java-annotations
2+
3+
Thank you for your interest in contributing!
4+
5+
For DCO sign-off, commit conventions, and code review process, see the organization-wide [CONTRIBUTING.md](https://github.com/reqstool/.github/blob/main/CONTRIBUTING.md).
6+
7+
## Prerequisites
8+
9+
- Java 21+
10+
- Maven 3.9+
11+
12+
## Setup
13+
14+
```bash
15+
git clone https://github.com/reqstool/reqstool-java-annotations.git
16+
cd reqstool-java-annotations
17+
```
18+
19+
## Build & Test
20+
21+
```bash
22+
mvn verify
23+
```

‎README.adoc‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎README.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
[![Commit Activity](https://img.shields.io/github/commit-activity/m/reqstool/reqstool-java-annotations?label=commits&style=for-the-badge)](https://github.com/reqstool/reqstool-java-annotations/pulse)
2+
[![GitHub Issues](https://img.shields.io/github/issues/reqstool/reqstool-java-annotations?style=for-the-badge&logo=github)](https://github.com/reqstool/reqstool-java-annotations/issues)
3+
[![License](https://img.shields.io/github/license/reqstool/reqstool-java-annotations?style=for-the-badge&logo=opensourceinitiative)](https://opensource.org/license/mit/)
4+
[![Build](https://img.shields.io/github/actions/workflow/status/reqstool/reqstool-java-annotations/build.yml?style=for-the-badge&logo=github)](https://github.com/reqstool/reqstool-java-annotations/actions/workflows/build.yml)
5+
[![Documentation](https://img.shields.io/badge/Documentation-blue?style=for-the-badge&link=docs)](https://reqstool.github.io)
6+
7+
# Reqstool Java Annotations
8+
9+
Java annotations for [reqstool](https://github.com/reqstool/reqstool-client) requirements traceability.
10+
11+
## Overview
12+
13+
Provides `@Requirements` and `@SVCs` annotations for linking Java code to requirements and software verification cases. Used together with the [Maven Plugin](https://github.com/reqstool/reqstool-java-maven-plugin) or [Gradle Plugin](https://github.com/reqstool/reqstool-java-gradle-plugin).
14+
15+
## Installation
16+
17+
Add the dependency to your project:
18+
19+
### Maven
20+
21+
```xml
22+
<dependency>
23+
<groupId>io.github.reqstool</groupId>
24+
<artifactId>reqstool-java-annotations</artifactId>
25+
<version>1.0.0</version>
26+
</dependency>
27+
```
28+
29+
### Gradle
30+
31+
```groovy
32+
implementation 'io.github.reqstool:reqstool-java-annotations:1.0.0'
33+
```
34+
35+
## Usage
36+
37+
```java
38+
import io.github.reqstool.annotations.Requirements;
39+
import io.github.reqstool.annotations.SVCs;
40+
41+
@Requirements({"REQ_001", "REQ_002"})
42+
public class MyService {
43+
// Implementation
44+
}
45+
46+
@Test
47+
@SVCs("SVC_001")
48+
public void testMyService() {
49+
// Test
50+
}
51+
```
52+
53+
## Documentation
54+
55+
Full documentation can be found [here](https://reqstool.github.io).
56+
57+
## Contributing
58+
59+
See the organization-wide [CONTRIBUTING.md](https://github.com/reqstool/.github/blob/main/CONTRIBUTING.md).
60+
61+
## License
62+
63+
MIT License.

‎docs/antora-playbook.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# yaml-language-server: $schema=https://raw.githubusercontent.com/asciidoctor/asciidoctor-intellij-plugin/main/src/main/resources/jsonSchemas/antoraPlaybookSchema.json
2+
# For local development only. Published site: https://reqstool.github.io
23

34
site:
45
title: Reqstool Java Annotations Documentation

0 commit comments

Comments
 (0)