Bem-vindo ao nosso projeto! Agradecemos o tempo que você dedica a nos ajudar a melhorar o cmd-chat. Temos uma lista de diretrizes bem diretas para alinhar suas PRs.
Para configurar um ambiente de desenvolvimento e começar a programar:
- Dê um Fork no projeto em https://github.com/dinosaurtirex/cmd-chat.
- Ative um ambiente virtual e use
pip install -e ".[dev]". Opcionalmente você precisará instalar as dependências ruff/pytest dopyproject.toml. - Crie uma branch clara:
git checkout -b feat/nova-feature. - Codifique a sua ideia. Siga atentamente a nossa convenção local: usamos
ruffpara padronizar todo o Python. Execute sempreruff format .eruff check --fix .antes do commit. - Siga semântica de commits:
feat,fix,refactor,docs,chore,ci,test,perf,security(Ex:fix: resolver vazamento x no core client). - Abra o PR! Siga nosso template padrão que será injetado do
.github/PULL_REQUEST_TEMPLATE.md. Responderemos rápido!
Sempre rode pytest tests/ no repositório antes de submeter uma issue. Garantir cobertura é ideal.
Obrigado por ajudar a comunidade open-source Python!