Skip to content

documentation/detect-magic-numbers#73

Open
aliyahnurdafika wants to merge 2 commits intodevfrom
documentation/detect-magic-numbers
Open

documentation/detect-magic-numbers#73
aliyahnurdafika wants to merge 2 commits intodevfrom
documentation/detect-magic-numbers

Conversation

@aliyahnurdafika
Copy link
Copy Markdown
Collaborator

@aliyahnurdafika aliyahnurdafika commented Feb 15, 2026

Update

Updates the Magic Number documentation to reflect the current implementation of the detector.

Summary

This PR adds documentation for the Magic Number detection feature introduced in PR #72

File Added/Updated

  1. documentation/detect_magic_numbers.md
  • Definition of Magic Number
  • Description of the full-file analysis pipeline
  • Explanation of the per-line detection workflow
  • Details of the context cleaning and filtering stages
  • Updated architecture diagrams
  • Current repository structure and module locations
  1. README.md
    Added instructions for running:
  • Full-file enrichment pipeline: Retrieves the full content of source code files at the PR head commit instead of analyzing patch snippets from diffs.
    (Note: A diff shows only the lines that changed between two commits)
  • Magic Number detection runner for repository-scale analysis

@aliyahnurdafika aliyahnurdafika changed the title Add Magic Number documentation and README updates documentation/detect-magic-numbers Mar 8, 2026
@d2r3v d2r3v force-pushed the dev branch 2 times, most recently from a8e6d00 to d14e5b5 Compare March 16, 2026 08:26
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.

1 participant