aicuriousminds/retrieval-augmented-generation

Set up Python Linting & TypeChecking

Open

#4 opened on May 25, 2024

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Python (0 forks)auto 404
good first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

Description

Currently we don't have any linting or typechecking. My suggestions are:

Assuming this, we should:

  • add linting
  • add typechecking
  • add git pre-commit hook to ensure that these are run on commit

Contributor guide

Research direction
Set up Ruff for linting and MyPy for typechecking, then configure pre commit hooks to run them automatically.
Tech stack
python
Domain
developer experience
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80