🤝 Como Contribuir - RafaPear/CLILib GitHub Wiki

CLILib é um projeto em evolução, aberto a melhorias e novas funcionalidades. Esta página explica como podes contribuir de forma eficaz — seja com código, ideias, documentação ou testes.

🛠️ Tipos de contributos possíveis

  • 💡 Sugerir novas funcionalidades (ex: comandos úteis, melhorias de UX)
  • 🧩 Criar comandos personalizados e partilhá-los com a comunidade
  • 🐛 Reportar bugs e comportamentos inesperados
  • 📚 Melhorar a documentação com exemplos, tutoriais ou correções
  • 🧪 Escrever scripts de teste para validar o comportamento da CLI
  • 🔍 Revisar código existente ou otimizar lógica

🚀 Começar a contribuir

  1. Faz fork do repositório
  2. Cria uma nova branch com o nome da funcionalidade:
git checkout -b feature/nome-da-funcionalidade
  1. Faz as tuas alterações localmente
  2. Testa os teus comandos e scripts
  3. Commita e faz push para o teu fork:
git add .
git commit -m "Adiciona comando novo: hello"
git push origin feature/nome-da-funcionalidade
  1. Abre um Pull Request com uma breve explicação

📋 Boas práticas

  • Mantém o código modular — se criares comandos novos, implementa a interface Command
  • Usa validateArgs(...) nos teus comandos
  • Escreve mensagens de erro claras e úteis
  • Dá nomes descritivos aos aliases e evita abreviações confusas
  • Adiciona comentários ao código quando necessário

📁 Organização recomendada

  • Comandos CLI → cmdUtils.commands.cli
  • Comandos de ficheiro → cmdUtils.commands.file
  • Comandos de diretório → cmdUtils.commands.directory
  • Operações com variáveis → cmdUtils.commands.varOp
  • Comandos diversos → cmdUtils.commands.functions

💬 Dúvidas ou sugestões?

Se tiveres perguntas ou quiseres discutir ideias para o projeto, podes abrir uma issue ou contactar diretamente os autores na secção de créditos.

Obrigado por ajudares a tornar o CLILib melhor 🚀