README.md

Contributor Documentation

Welcome to the Reqvire contributor documentation! This folder contains information for developers who want to contribute to Reqvire.

For Users

Looking for how to use Reqvire? Visit www.reqvire.org for:

• Installation instructions
• User guides and tutorials
• Command reference
• Configuration options
• Best practices

For Contributors

This documentation is for those who want to contribute to Reqvire's development:

• Contributing Guide - How to contribute code, tests, and documentation
• Code of Conduct - Our community standards
• Contributor License Agreement - Legal terms for contributions
• Codex Skills - Reqvire Codex skill package and global installation
• Release Process - How releases are created
• Development Guide - Technical architecture and development workflow

Development Quick Start

Prerequisites

Install Rust and Cargo

Install Rust using rustup:

curl -sSf https://sh.rustup.rs | sh

Follow the on-screen prompts to complete the installation, then verify:

rustc --version
cargo --version

Building from Source

Clone the repository

git clone https://github.com/reqvire-org/reqvire.git
cd reqvire

Build the project

cargo build

Run tests

cargo test

Run Reqvire locally

cargo run -- --help

Install the binary (optional)

cargo install --path .

This will install the binary to ~/.cargo/bin/reqvire

Project Structure

reqvire/
├── core/              # Core library (parsing, model, analysis)
├── cli/               # Command-line interface
├── requirements/    # Reqvire's own requirements and model
├── tests/             # End-to-end tests
└── doc/              # Contributor documentation (this folder)

Key Resources

• Project Specifications - Reqvire's own requirements model
• Architecture - System architecture documentation
• E2E Tests Guide - How to write and run tests
• GitHub Issues - Report bugs and request features
• GitHub Discussions - Ask questions and share ideas

Contribution Workflow

1. Read the Contributing Guide
2. Open or join an issue discussion before code changes
3. Wait for maintainer invitation before opening a PR
4. Follow MBSE workflow for invited PRs (see CLAUDE.md):
   • Add requirements first
   • Define verifications
   • Implement tests
   • Write code
   • Link implementation to requirements
5. Test your changes
6. Submit an invited pull request

Need Help?

• Review the user documentation to understand how Reqvire works
• Check the CLAUDE.md guide for development patterns
• Open a GitHub Discussion to ask questions
• Join our community to connect with other contributors

---

Thank you for contributing to Reqvire!