Data

Tools

Indexes

Applications

Experiments

Open Source Science

org.requs

Controlled Natural Language for Requirements Specifications

https://github.com/yegor256/requs

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 1 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: acm.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.5%) to scientific vocabulary

Keywords

java maven-plugin natural-language-processing requirements requirements-management
Last synced: 6 months ago · JSON representation ·

Repository

Controlled Natural Language for Requirements Specifications

Basic Info
  • Host: GitHub
  • Owner: yegor256
  • License: other
  • Language: XSLT
  • Default Branch: master
  • Homepage: https://www.requs.org
  • Size: 2.87 MB
Statistics
  • Stars: 41
  • Watchers: 8
  • Forks: 4
  • Open Issues: 36
  • Releases: 23
Topics
java maven-plugin natural-language-processing requirements requirements-management
Created almost 13 years ago · Last pushed 8 months ago
Metadata Files
Readme License Citation

README.md

EO principles respected here DevOps By Rultor.com We recommend IntelliJ IDEA

mvn codecov PDD status Maven Central Hits-of-Code

REQUS is a controlled natural language (CNL) for requirements specifications. It is explained in details in this paper, which was published in the Proceedings of the 1st ACM SIGPLAN International Workshop on Beyond Code: No Code (BCNC). More details about REQUS syntax you can find at 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):

xml <reporting> <plugins> <plugin> <groupId>org.requs</groupId> <artifactId>requs-maven-plugin</artifactId> <version>...</version> </plugin> </plugins> </reporting>

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

Owner

  • Name: Yegor Bugayenko
  • Login: yegor256
  • Kind: user
  • Location: Russia
  • Company: @zerocracy

Author of "Elegant Objects" book series (buy them on Amazon); architect of @objectionary; founder of @zerocracy; creator of @zold-io

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Bugayenko"
  given-names: "Yegor"
  orcid: "https://orcid.org/0000-0001-6370-0678"
title: "REQUS: Controlled Natural Language for Requirements Specification"
version: 0.0.0
date-released: 2022-05-09
url: "https://github.com/yegor256/requs"

GitHub Events

Total
  • Watch event: 2
  • Delete event: 1
  • Push event: 67
  • Pull request event: 2
  • Create event: 1
Last Year
  • Watch event: 2
  • Delete event: 1
  • Push event: 67
  • Pull request event: 2
  • Create event: 1

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 161
  • Total pull requests: 25
  • Average time to close issues: 2 months
  • Average time to close pull requests: 11 months
  • Total issue authors: 14
  • Total pull request authors: 6
  • Average comments per issue: 7.59
  • Average comments per pull request: 2.04
  • Merged pull requests: 7
  • Bot issues: 1
  • Bot pull requests: 18
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 2
View more stats
Top Authors
Issue Authors
  • antonxt (48)
  • yegor256 (16)
  • autronix (3)
  • kikec (3)
  • davvd (3)
  • ataran (2)
  • andrewbol (1)
  • caarlos0 (1)
  • amihaiemil (1)
  • longtimeago (1)
  • v-karbovnichy (1)
  • avidrucker (1)
  • antonini (1)
  • renovate[bot] (1)
Pull Request Authors
  • renovate[bot] (20)
  • nikzor (4)
  • dependabot[bot] (2)
  • v-karbovnichy (2)
  • kikec (1)
  • iakunin (1)
Top Labels
Issue Labels
30 mins (63) DEV (61) TS/FIX (58) bug (47) @yegor256 (34) enhancement (24) invalid (8) question (3) wontfix (2) cosmetic (1) duplicate (1)
Pull Request Labels
dependencies (2) @yegor256 (1)

Packages

  • Total packages: 4
  • Total downloads: unknown
  • Total dependent packages: 4
    (may contain duplicates)
  • Total dependent repositories: 1
    (may contain duplicates)
  • Total versions: 96
repo1.maven.org: org.requs:requs-core

Requirements Definition Language

  • Versions: 24
  • Dependent Packages: 3
  • Dependent Repositories: 1
Rankings
Dependent packages count: 17.6%
Dependent repos count: 20.8%
Average: 28.5%
Stargazers count: 33.4%
Forks count: 42.2%
Last synced: 6 months ago
repo1.maven.org: org.requs:requs-exec

Requirements Definition Language

  • Versions: 24
  • Dependent Packages: 1
  • Dependent Repositories: 0
Rankings
Stargazers count: 24.2%
Forks count: 29.0%
Average: 29.3%
Dependent repos count: 32.0%
Dependent packages count: 32.0%
Last synced: 6 months ago
repo1.maven.org: org.requs:requs

Requirements Definition Language

  • Versions: 24
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Stargazers count: 23.7%
Forks count: 29.0%
Dependent repos count: 32.0%
Average: 33.4%
Dependent packages count: 48.9%
Last synced: 6 months ago
repo1.maven.org: org.requs:requs-maven-plugin

Requirements Definition Language

  • Versions: 24
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Stargazers count: 24.2%
Forks count: 29.0%
Dependent repos count: 32.0%
Average: 33.5%
Dependent packages count: 48.9%
Last synced: 6 months ago

Dependencies

pom.xml maven
  • javax.servlet:javax.servlet-api 4.0.1 provided
  • org.projectlombok:lombok 1.18.24 provided
  • com.jcabi:jcabi-log 0.21.0
  • com.jcabi:jcabi-manifests 1.2.1
  • com.jcabi:jcabi-matchers 1.5.3
  • com.jcabi:jcabi-xml 0.23.2
  • commons-io:commons-io 2.11.0
  • junit:junit 4.13.2
  • log4j:log4j 1.2.17
  • net.sourceforge.saxon:saxon 9.1.0.8
  • org.antlr:antlr4-runtime 4.9.2
  • org.junit.jupiter:junit-jupiter-params 5.9.0
  • org.junit.vintage:junit-vintage-engine 5.9.0
  • org.mockito:mockito-core 4.6.1
  • org.slf4j:slf4j-log4j12 2.0.0-alpha5
requs-core/pom.xml maven
  • javax.servlet:javax.servlet-api provided
  • com.google.guava:guava 31.1-jre
  • com.jcabi.incubator:xembly 0.26.2
  • com.jcabi:jcabi-aspects 0.24.1
  • com.jcabi:jcabi-immutable 1.5
  • com.jcabi:jcabi-log
  • com.jcabi:jcabi-manifests
  • com.jcabi:jcabi-xml
  • com.vladsch.flexmark:flexmark 0.64.0
  • com.vladsch.flexmark:flexmark-util-ast 0.64.0
  • com.vladsch.flexmark:flexmark-util-data 0.64.0
  • commons-codec:commons-codec 1.15
  • commons-io:commons-io
  • javax.validation:validation-api 2.0.1.Final
  • net.sourceforge.plantuml:plantuml 8059
  • net.sourceforge.saxon:saxon
  • org.apache.commons:commons-lang3 3.12.0
  • org.apache.commons:commons-text 1.9
  • org.projectlombok:lombok
  • com.jcabi.incubator:phandom 0.4 test
  • com.jcabi:jcabi-matchers test
requs-exec/pom.xml maven
  • com.jcabi:jcabi-manifests
  • com.jcabi:jcabi-xml 0.23.2
  • commons-io:commons-io
  • javax.servlet:javax.servlet-api
  • log4j:log4j
  • net.sf.jopt-simple:jopt-simple 6.0-alpha-3
  • org.antlr:antlr4-runtime
  • org.projectlombok:lombok
  • org.requs:requs-core ${project.version}
  • org.slf4j:slf4j-log4j12
  • com.jcabi:jcabi-matchers test
requs-exec/src/it/compiles-simple-syntax/pom.xml maven
  • @project.groupId@:@project.artifactId@ @project.version@
requs-maven-plugin/pom.xml maven
  • org.apache.maven.plugin-tools:maven-plugin-annotations 3.6.4 provided
  • com.jcabi:jcabi-log
  • com.jcabi:jcabi-maven-slf4j 0.10
  • com.jcabi:jcabi-xml 0.23.2
  • net.sourceforge.saxon:saxon
  • org.antlr:antlr4-runtime
  • org.apache.maven.doxia:doxia-sink-api 2.0.0-M3
  • org.apache.maven.doxia:doxia-site-renderer 2.0.0-M3
  • org.apache.maven.reporting:maven-reporting-api 4.0.0-M2
  • org.apache.maven.reporting:maven-reporting-impl 4.0.0-M2
  • org.apache.maven:maven-core 3.8.6
  • org.apache.maven:maven-plugin-api 3.8.6
  • org.requs:requs-core ${project.version}
  • org.apache.maven.plugin-testing:maven-plugin-testing-harness 3.3.0 test
  • org.apache.maven:maven-compat 3.8.6 test
requs_pygment/setup.py pypi
  • pygments *
jekyll/Gemfile rubygems
  • jekyll = 4.0.1
  • jekyll-sass = 1.1.0
  • jekyll-sass-converter = 2.1.0
.github/workflows/codecov.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-java v3 composite
  • codecov/codecov-action v3 composite
.github/workflows/jekyll.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • jeffreytse/jekyll-deploy-action v0.3.1 composite
.github/workflows/mvn.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/setup-java v3 composite
.github/workflows/pdd.yml actions
  • actions/checkout v3 composite
  • g4s8/pdd-action master composite
.github/workflows/xcop.yml actions
  • actions/checkout v3 composite
  • g4s8/xcop-action master composite
requs-maven-plugin/src/it/absent-input-dir/pom.xml maven
requs-maven-plugin/src/it/broken-spec/pom.xml maven
requs-maven-plugin/src/it/report-in-site/pom.xml maven
requs-maven-plugin/src/it/simple-compile/pom.xml maven