Storia-AI/sage

Feature request: Exclude auto-generated files

Open

#47 opened on Oct 2, 2024

View on GitHubContributor guide
 (6 comments) (0 reactions) (2 assignees)Python (116 forks)auto 404
good first issuehacktoberfest🔥 difficulty: 2

Repository metrics

Stars
 (1,267 stars)
PR merge metrics
 (PR metrics pending)

Description

Some repos have hundreds of auto-generated files, with limited utility in actually understanding the repo.

We'll have to implement some heuristics to detect such files (based on filename and content), and offer an option to exclude them from indexing. When they dominate the repo, they can really damage retrieval quality.

Contributor guide

Research direction
Investigate common patterns for auto generated files (e.g., compiled outputs, lock files, large generated directories). Implement heuristics based on filename extensions and content markers (e.g., generated by tools). Consider providing an option to exclude these files from indexing.
Tech stack
python
Domain
backendsearchai
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonBasic knowledge of file handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60