Skip to content

Conversation

@mr-raj12
Copy link

@mr-raj12 mr-raj12 commented Feb 2, 2026

Summary

Spelling typos found using codespell and fixed manually across 16 files (24 corrections).

Scope

  • Docs: CHANGELOG.rst, installation.rst, reference_importer_overview.rst, reference_improver_overview.rst, tutorial_add_importer_pipeline.rst,
    tutorial_add_improver_pipeline.rst
  • Source: federated/README.rst, federated/__init__.py, import_runner.py, improve_runner.py, models.py, pipelines/nvd_importer.py,
    pipelines/v2_importers/nvd_importer.py, utils.py, views.py
  • Tests: test_nginx_importer_pipeline.py

All changes are limited to comments, docstrings, documentation, and one local test variable rename. No functional code changes.

Full list of corrections: #2134

Fixes #2134

Signed-off-by: Mrityunjay Raj mr.raj.earth@gmail.com

Signed-off-by: Mrityunjay Raj <mr.raj.earth@gmail.com>
@mr-raj12
Copy link
Author

mr-raj12 commented Feb 2, 2026

Hi @pombredanne,

This PR fixes 24 spelling typos across 16 files (docs, source, and tests) — found
using codespell and corrected manually. No functional code changes, except one
local test variable rename (reponse_filesresponse_files).

Details of all corrections are in #2134.

Would appreciate your review when you get a chance. Thank you!

@mr-raj12
Copy link
Author

mr-raj12 commented Feb 2, 2026

@pombredanne — a couple of related observations while exploring on the repo:

  1. Missing issue templates: VulnerableCode currently has no issue templates
    (unlike scancode-toolkit which has bug report, feature request, etc.). Would it
    be useful to add .github/ISSUE_TEMPLATE/ templates here as well? I'd be happy
    to work on that if you'd like.

  2. Automated spell checking: I've been running codespell manually across several
    aboutcode-org repos (scancode.io, scancode-toolkit, vulnerablecode). It might be
    worth adding a GitHub Actions workflow to run codespell as a CI check — this would
    catch typos early in PRs before they're merged. Something like:

    - uses: codespell-project/actions-codespell@v2
      with:
        skip: "*.json,*.yaml,*.LICENSE"
        ignore_words_list: "..."
    
    I could put together a PR for this if there's interest, potentially as a shared
    workflow across the aboutcode-org repos.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix spelling typos in docs, source, and tests

1 participant