SylphAI-Inc/AdalFlow

Apply consistent coding and documenting styling

Open

#273 opened on Nov 21, 2024

View on GitHub
 (11 comments) (0 reactions) (0 assignees)Python (374 forks)github user discovery
P1[adalflow] suggest improvementhelp wanted

Repository metrics

Stars
 (4,164 stars)
PR merge metrics
 (PR metrics pending)

Description

Outline & Motivation

Without enforcing the same formatting, developers end up committing code/files that only changes formatting, making it hard to review.

Pitch

We might need a Makefile and add either the formatting here and modify the root pyproject.toml, as described in the contributor guide that commit hook is applied here.

Additional context

No response

Contributor guide

Research direction
Set up a Makefile with formatting commands and modify pyproject.toml to add linting/formatting tools like black or ruff.
Tech stack
python
Domain
developer experiencetooling
Issue type
Refactor
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
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70