Introduction
Introduction
rqm is a requirement manager for software projects. A requirement is a small YAML file that lives in your repository, next to the code. rqm reads those files, checks them, and answers questions about them, and it does it the same way on every machine, offline.
The idea that sets rqm apart is that a requirement is never marked as verified by hand. Whether a requirement is verified is computed from evidence: the results of the tests that you bind to it. This book describes all of it: reading and checking a project, binding tests to requirements, running them, judging the results, and keeping the accepted state in a baseline.
What this book covers
- A tutorial that takes a small Rust project from nothing to a checked set of requirements.
- The command line: every command, its options, its output and its exit codes.
- The file formats: the configuration file and the requirement file.
- How tests are tied to requirements, and how to run rqm in CI.
- How to install rqm.
- How rqm works and why, for when you want to know the reasons behind the rules.
- A reference part with the exact rules, for when you need them.
A first look
This is a small project with four requirements. rqm list shows them, and rqm check reads every file and reports what is wrong with any of them, if anything is.
$ rqm list
ID KIND STATUS PRIORITY TITLE
RQM-1 functional approved must Users can sign in
RQM-2 functional approved must Sessions expire
RQM-3 constraint approved should Passwords are never logged
RQM-4 functional draft may Sign-in attempts are rate limited
4 of 4 requirements shown
$ rqm check
checked 4 requirements (loaded 4 of 4 discovered requirement files)
Every command output in this book is produced by the program and checked against it, so what you read here is what rqm prints.
Platforms
rqm is developed and tested on Linux. It is currently untested on Windows and macOS. It may work there for the commands that only read a project. init and create are implemented on Windows, but their code for that platform has not been run, and nothing in this book promises anything on either platform.