docs: add research-backed documentation for v0.6.2

- Added docs/WHY.md with user-friendly rule explanations and authoritative sources
- Added docs/RESEARCH_CITATIONS.md with 551 lines of academic and industry references
- Updated README.md with micro-citations under each feature
- Enhanced CLI help with 'BACKED BY RESEARCH' section
- Updated AI tools mentions across all docs (GitHub Copilot, Cursor, Windsurf, Claude, ChatGPT, Cline)
- Organized documentation structure: moved RESEARCH_CITATIONS.md to docs/
- Version bump: 0.6.1 -> 0.6.2

Research backing includes:
- Academia: MIT Course 6.031, ScienceDirect studies
- Books: Clean Architecture (Martin 2017), DDD (Evans 2003)
- Industry: Google, Microsoft, Airbnb style guides, SonarQube
- Experts: Martin Fowler, Robert C. Martin, Eric Evans, Alistair Cockburn
This commit is contained in:
imfozilbek
2025-11-24 22:51:35 +05:00
parent 3ddcff1be3
commit d50cbe1a97
7 changed files with 1002 additions and 10 deletions

View File

@@ -5,6 +5,42 @@ All notable changes to @samiyev/guardian will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [0.6.2] - 2025-11-24
### Added
**📚 Research-Backed Documentation**
Guardian's detection rules are now backed by scientific research and industry standards!
-**New Documentation**
- `docs/WHY.md` - User-friendly explanations for each rule with authoritative sources
- `docs/RESEARCH_CITATIONS.md` - Complete academic and industry references (551 lines)
- Organized by detection type with quick navigation
-**Micro-Citations in README**
- Each feature now includes one-line citation with "Why?" link
- Examples: "Based on MIT 6.031, SonarQube RSPEC-109"
- Non-intrusive, opt-in for users who want to learn more
-**CLI Help Enhancement**
- Added "BACKED BY RESEARCH" section to `--help` output
- Mentions MIT, Martin Fowler, Robert C. Martin, industry standards
- Link to full documentation
### Changed
- **Documentation Structure**: Moved `RESEARCH_CITATIONS.md` to `docs/` directory for better organization
- **All internal links updated** to reflect new documentation structure
### Backed By
Our rules are supported by:
- 🎓 **Academia**: MIT Course 6.031, ScienceDirect peer-reviewed studies
- 📚 **Books**: Clean Architecture (Martin 2017), DDD (Evans 2003), Enterprise Patterns (Fowler 2002)
- 🏢 **Industry**: Google, Microsoft, Airbnb style guides, SonarQube standards
- 👨‍🏫 **Experts**: Martin Fowler, Robert C. Martin, Eric Evans, Alistair Cockburn
## [0.6.1] - 2025-11-24
### Improved
@@ -452,7 +488,7 @@ Code quality guardian for vibe coders and enterprise teams - your AI coding comp
#### Developer Experience
- 🤖 **Built for AI-Assisted Development**
- Perfect companion for Claude, GPT, Copilot, Cursor
- Perfect companion for GitHub Copilot, Cursor, Windsurf, Claude, ChatGPT, Cline
- Catches common AI code smells (hardcoded values, architecture violations)
- Educational error messages with fix suggestions
- Designed for vibe coding workflow: AI writes → Guardian reviews → AI fixes → Ship