Guía para contribuyentes#

¡Bienvenido a la documentación para contribuyentes de Construbot!

Descripción general#

¡Gracias por tu interés en contribuir a Construbot! Esta guía cubre todo lo que necesita saber sobre cómo contribuir con código, documentación, traducciones y más.

Nota

¿Colabora por primera vez? Comience con Getting-Started

Formas de contribuir#

💻 Contribuciones de código

  • Corrección de errores

  • Nuevas características

  • Mejoras de rendimiento

  • Refactorización de código

📚 Documentación

  • Corregir errores tipográficos y

  • Mejorar los documentos existentes

  • Agregar nuevas guías

  • Traducir al español

🌍 Traducciones

  • Traducir cadenas de UI

  • Actualizar glosario español→inglés

  • Revisar traducciones

🐛 Informes de errores

  • Informar problemas

  • Proporcionar pasos de reproducción.

  • Sugerir correcciones

✨ Solicitudes de funciones

  • Proponer nuevas funciones.

  • Discutir mejoras

  • Votar propuestas

Inicio rápido#

1. Bifurcación y clonación:

# Fork on GitHub, then clone
git clone https://github.com/YOUR-USERNAME/construbot.git
cd construbot

2. Configurar el entorno de desarrollo:

# Using Docker (recommended)
make buildev

# Or local setup
python -m venv venv
source venv/bin/activate
pip install -r requirements/local.txt

3. Crear rama de funciones:

git checkout -b feature/my-awesome-feature

4. Realice cambios y pruebe:

make test

5. Enviar solicitud de extracción

Consulte Getting-Start para conocer los pasos detallados.

Flujo de trabajo de desarrollo#

1. Encuentre un problema o cree uno

Navegar por https://github.com/javier-llamas/construbot/issues

2. Discutir el enfoque

Comente sobre el problema antes de comenzar un trabajo importante.

3. Escribir código

Siga las pautas Estilo de código

4. Escribir pruebas

Ver Pruebas

5. Actualizar documentación

Documentar nuevas características

6. Enviar PR

Incluir descripción y pruebas claras.

Estilo de código#

Pitón:

  • Siga PEP 8

  • Utilice negro para formatear

  • Se recomienda escribir sugerencias

  • Cadenas de documentación para API públicas

Django:

  • Siga las mejores prácticas de Django

  • Utilice las funciones integradas de Django

  • Todas las consultas del ámbito de la empresa

Consulte Estilo de código para obtener pautas completas.

Pruebas#

Ejecutar pruebas:

# Full test suite
make test

# Specific test
pytest tests/test_models.py::test_contract_creation

# With coverage
make test
open htmlcov/index.html

Consulte Pruebas para obtener una guía de prueba.

Documentación#

Documentos de compilación:

cd docs
make html
open _build/html/index.rst

Reconstrucción automática:

make livehtml

Consulte Documentación para conocer las pautas de documentación.

Traducción#

Glosario español→inglés:

Consulte Glosario de traducción para ver las asignaciones de términos completas.

Agregar traducciones:

cd docs
make update-translations
# Edit locale/es/LC_MESSAGES/*.po

Consulte translation/index para obtener una guía de traducción.

Directrices para solicitudes de extracción#

Antes de enviar:

✅ Pasan las pruebas (hacer prueba)

✅ El código sigue la guía de estilo

✅ Documentación actualizada

✅ Los compromisos son claros y atómicos

✅ La descripción de PR explica los cambios

Plantilla de relaciones públicas:

## Description
Brief description of changes

## Motivation
Why is this change needed?

## Changes
- List of changes made

## Testing
How was this tested?

## Screenshots (if applicable)

## Checklist
- [ ] Tests pass
- [ ] Documentation updated
- [ ] Follows code style

Comunidad#

Sea respetuoso e inclusivo

Seguimos el Código de conducta del Pacto del colaborador.

Pide ayuda

  • Problemas de GitHub

  • Discusiones de GitHub (si están disponibles)

Dar comentarios

¡Tus comentarios ayudan a mejorar Construbot!

Secciones de documentación#

Recursos#

Licencia#

Al contribuir, usted acepta que sus contribuciones tendrán la licencia AGPLv3.

Gracias#

¡Gracias por contribuir a Construbot! Sus contribuciones ayudan a que este proyecto sea mejor para todos.