Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (46 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

65 lines (46 loc) · 1.42 KB

Contributing to CVE Scanner CLI

Thanks for contributing.

Ways to Contribute

  • Report bugs
  • Suggest features
  • Improve documentation
  • Submit code improvements

Development Setup

  1. Fork and clone the repository.
  2. Create and activate a virtual environment.
  3. Install dependencies.
git clone https://github.com/DebaA17/CVE-scanner-cli.git
cd CVE-scanner-cli
python3 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt

Local Checks Before Opening a PR

Run a few smoke checks before submitting:

python3 cve_search_cli.py --version
python3 cve_search_cli.py --id CVE-2025-55184 --json
python3 cve_search_cli.py --keyword wordpress --limit 3 --json

If you changed install behavior, also verify:

bash setup.sh --local
bash uninstall.sh

Pull Request Guidelines

  • Create a focused branch per change.
  • Keep pull requests small and easy to review.
  • Update README.md if behavior or flags change.
  • Add clear reproduction steps for bug fixes.
  • Do not include unrelated formatting-only changes.

Commit Message Tips

Use short, clear commit messages that describe what changed and why.

Examples:

  • fix: handle NVD timeout retry path
  • docs: add security disclosure policy
  • chore: improve setup script shell detection

Security Issues

Do not report security vulnerabilities in public issues. Use the private process described in SECURITY.md.