Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
139 lines (105 loc) · 3.28 KB

CONTRIBUTING.md

File metadata and controls

139 lines (105 loc) · 3.28 KB

Contribuyendo a Android Gradle Analyzer

¡Gracias por tu interés en contribuir! 🎉

🚀 Cómo Contribuir

Reportar Bugs

  1. Verifica que el bug no haya sido reportado antes
  2. Abre un issue
  3. Incluye:
    • Descripción clara del problema
    • Pasos para reproducirlo
    • Comportamiento esperado vs actual
    • Versión de Python
    • Sistema operativo
    • Ejemplo de archivo gradle (si es relevante)

Sugerir Mejoras

  1. Abre un issue con el tag enhancement
  2. Describe la funcionalidad que te gustaría ver
  3. Explica por qué sería útil
  4. Proporciona ejemplos de uso si es posible

Enviar Pull Requests

  1. Fork el repositorio
  2. Crea una rama desde main: 
    git checkout -b feature/mi-nueva-funcionalidad
  3. Haz tus cambios:
    • Sigue el estilo de código existente
    • Agrega comentarios donde sea necesario
    • Actualiza documentación si es relevante
  4. Prueba tus cambios: 
    python3 gradle_analyzer.py /ruta/test
python3 external_callers.py /ruta/test modulo
  5. Commit con mensajes descriptivos: 
    git commit -m "Agrega soporte para formato Groovy DSL"
  6. Push a tu fork: 
    git push origin feature/mi-nueva-funcionalidad
  7. Abre un Pull Request con:
    • Descripción clara de los cambios
    • Referencias a issues relacionados
    • Screenshots si aplica

📝 Guía de Estilo

Python

  • Usa 4 espacios para indentación
  • Nombres de funciones y variables en snake_case
  • Nombres de clases en PascalCase
  • Docstrings para funciones públicas
  • Líneas máximo 100 caracteres

Ejemplo:

def analyze_dependencies(self):
    """
    Analiza las dependencias desde los archivos gradle

    Returns:
        self para encadenamiento
    """
    for module in self.modules:
        self._parse_gradle_file(module)
    return self

Commits

Usa mensajes claros y en presente:

✅ Bueno:

  • Agrega soporte para Gradle Kotlin DSL
  • Corrige detección de dependencias anidadas
  • Mejora documentación de instalación

❌ Malo:

  • Fix
  • Changes
  • Updated stuff

🧪 Testing

Antes de enviar un PR, prueba con:

  1. Proyecto simple (pocos módulos)
  2. Proyecto complejo (muchos módulos anidados)
  3. Diferentes formatos de gradle:
    • build.gradle (Groovy)
    • build.gradle.kts (Kotlin DSL)

💡 Ideas para Contribuir

Features Buscadas

  • Soporte para settings.gradle.kts
  • Detección de dependencias transitivas
  • Análisis de dependencias circulares
  • Exportar a formato JSON/YAML
  • Modo interactivo/CLI mejorado
  • Análisis de performance de build
  • Sugerencias de optimización

Mejoras de Documentación

  • Tutorial en video
  • Más ejemplos de uso
  • Traducción a otros idiomas
  • Guía de arquitectura modular
  • Comparación con otras herramientas

🤔 ¿Preguntas?

Si tienes dudas sobre cómo contribuir, abre un issue con el tag question o únete a las discusiones.

📜 Código de Conducta

  • Se respetuoso y constructivo
  • Acepta críticas constructivas
  • Enfócate en lo mejor para el proyecto
  • Sé paciente con otros colaboradores

¡Gracias por hacer este proyecto mejor! 🙏