SylphAI-Inc/AdalFlow

Apply consistent coding and documenting styling

Open

#273 aberto em 21 de nov. de 2024

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

Métricas do repositório

Stars
 (4.164 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Configure um Makefile com comandos de formatação e modifique pyproject.toml para adicionar ferramentas de linting/formatação como black ou ruff.
Pilha de tecnologia
python
Domain
developer experiencetooling
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitPython
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70