https://github.com/yegor256/requs

Controlled Natural Language for Requirements Specifications
https://github.com/yegor256/requs

java maven-plugin natural-language-processing requirements requirements-management

Last synced: 11 months ago
JSON representation

Controlled Natural Language for Requirements Specifications

• Host: GitHub
• URL: https://github.com/yegor256/requs
• Owner: yegor256
• License: other
• Created: 2013-04-21T17:55:05.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2024-04-30T05:52:25.000Z (almost 2 years ago)
• Last Synced: 2024-05-01T23:12:23.932Z (almost 2 years ago)
• Topics: java, maven-plugin, natural-language-processing, requirements, requirements-management
• Language: Java
• Homepage: https://www.requs.org
• Size: 2.73 MB
• Stars: 37
• Watchers: 9
• Forks: 5
• Open Issues: 37
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Citation: CITATION.cff

Awesome Lists containing this project

README

          


[![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)

[![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/requs)](http://www.rultor.com/p/yegor256/requs)

[![We recommend IntelliJ IDEA](https://www.elegantobjects.org/intellij-idea.svg)](https://www.jetbrains.com/idea/)

[![mvn](https://github.com/yegor256/requs/actions/workflows/mvn.yml/badge.svg)](https://github.com/yegor256/requs/actions/workflows/mvn.yml)

[![codecov](https://codecov.io/gh/yegor256/requs/branch/master/graph/badge.svg)](https://codecov.io/gh/yegor256/requs)

[![PDD status](http://www.0pdd.com/svg?name=yegor256/requs)](http://www.0pdd.com/p?name=yegor256/requs)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.requs/requs/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.requs/requs)

[![Hits-of-Code](https://hitsofcode.com/github/yegor256/requs)](https://hitsofcode.com/view/github/yegor256/requs)

REQUS is a controlled natural language (CNL) for requirements specifications.

It is explained in details in [this paper](https://www.yegor256.com/pdf/2021/requs.pdf),

which was published in the

[Proceedings of the 1st ACM SIGPLAN International Workshop on Beyond Code: No Code (BCNC)](https://dl.acm.org/doi/abs/10.1145/3486949.3486963).

More details about REQUS syntax you can find at [www.requs.org](http://www.requs.org/).

In order to use it in a Java project, just add this plugin to your `pom.xml`

(get the latest version [from here](https://github.com/yegor256/requs/releases)):

```xml

  

    

      org.requs

      requs-maven-plugin

      ...

    

  

```

Then, add REQUS files to `src/main/requs` and name them as `main.req`, etc.

Then, run `mvn clean site` and you will see a report at `target/site/requs`.

## How to contribute?

Fork the repository, make changes, submit a pull request.

We promise to review your changes same day and apply to

the `master` branch, if they look correct.

Please run Maven build before submitting a pull request:

```

$ mvn clean install -Pqulice

```

To render the site and edit its pages:

```

$ cd jekyll

$ bundle install

$ bundle exec jekyll serve --drafts

```