🛠️ Guia de Contribuição
Agradecemos por querer contribuir com o SDK do AbacatePay! Siga os passos abaixo para começar:
✅ Pré-requisitos
🚀 Passo a passo
-
Faça um fork do repositório Clique aqui para fazer o fork no GitHub
-
Clone o repositório do seu fork Substitua
seu-usuariopelo seu nome de usuário no GitHub:git clone https://github.com/seu-usuario/abacatepay.git cd abacatepay -
Configure o ambiente virtual com o Poetry
Caso ainda não tenha o Poetry instalado, siga as instruções nesta página.
poetry install -
Instalando pre-commit hooks Para garantir a qualidade do código durante o desenvolvimento, usamos pre-commit.
poetry run pre-commit install
-
Crie uma nova branch para suas alterações Escolha um nome descritivo para a branch:
git checkout -b nome-da-feature -
Execute os testes para garantir que tudo continua funcionando
poetry run task test -
Verifique a formatação e os padrões de código O comando de testes já verifica o estilo do código com o Ruff. Caso necessário, corrija manualmente com:
poetry run task lint poetry run task fmt -
Não esqueça de documentar suas alterações Para documentação nos utilizamos o MKdocs. Também usamos MKdocstrings para gerar a referência a partir de docstrings, portanto não esqueça de documentar suas funções e módulos devidamente.
-
Faça commit e envie suas alterações
git add . git commit -m "Adiciona feature ou correção: descrição curta" git push origin nome-da-feature -
Abra um Pull Request no GitHub e descreva suas alterações com clareza.
☕ Pronto! Agora é só tomar um café enquanto sua contribuição é revisada. Obrigado por ajudar a melhorar o SDK do AbacatePay! 🙌