dependency-check / dependency-check/DependencyCheck
Proposal: Contributor Architecture Overview Documentation
- Dominant language
- Java
- Stars
- 7.7k
- Forks
- 1.4k
- Avg merge
- 9d 22h
- Merged PRs (30d)
- 13
Description
Hello maintainers,
While exploring the project structure (CLI, Engine, analyzers, and vulnerability matching flow), I noticed that new contributors may find it challenging to understand the internal architecture and data flow.
I would like to propose contributing a concise "Architecture Overview for Contributors" document explaining:
- High-level architecture (CLI → Engine → Analyzers → NVD matching → Report generation)
- How dependencies are identified and analyzed
- How vulnerability matching works (CPE, version ranges, CVSS threshold logic)
- Suggested entry points for new contributors
Before starting, I would like to confirm whether:
1. Such documentation already exists but I may have missed it, or
2. The maintainers would welcome this addition (e.g., in docs/ or Wiki).
I would be happy to align with any preferred structure or guidelines.
Thank you.
Contributor guide
Assessment
This issue has not been assessed yet.