tracey-cli

0.1.0 • Public • Published

Project Tracey

Codecov npm downloads npm version NPM

A markdown-based requirements tool for creating and updating trace links between structured requirements and source code.

Workflow

  • Document the project requirements in markdown files
  • Each requirement is assigned a unique ID in the markdown frontmatter
  • Annotate the requirement ID in the source code
  • Run tracey to generate the trace links

For more information have a look a the Getting Started guide. If you are interested in how the generated trace links look, have a look at a real requirements document of this project.

Contributing

I develop this project for my master studies and I might get in trouble because of code ownership if I accept pull requests. Therefore, pull request will not be accepted until I have finished my master studies. After that, pull requests will be accepted.

Package Sidebar

Install

npm i tracey-cli

Weekly Downloads

1

Version

0.1.0

License

ISC

Unpacked Size

45.2 kB

Total Files

25

Last publish

Collaborators

  • k.hatvan