Empezando#

Primeros pasos para contribuir a Construbot.

Requisitos previos#

Requerido:

  • git

  • Pitón 3.9.17+

  • Docker y Docker Compose (recomendado)

O para desarrollo local:

  • PostgreSQL 12+

  • Redis 6+

  • Entorno virtual

Bifurcación y clonación#

1. Repositorio de bifurcación:

Visita https://github.com/javier-llamas/construbot y haz clic en «Fork»

2. Clona tu tenedor:

git clone https://github.com/YOUR-USERNAME/construbot.git
cd construbot

3. Agregar control remoto ascendente:

git remote add upstream https://github.com/javier-llamas/construbot.git

Configuración de desarrollo#

Usando Docker (recomendado):

# Build and start
make buildev

# Create superuser
make superuser

# Run tests
make test

Usando el entorno local:

# Create virtualenv
python3.9 -m venv venv
source venv/bin/activate

# Install dependencies
pip install -r requirements/local.txt

# Setup database
python manage.py migrate

# Run tests
pytest

Hacer cambios#

1. Crear rama de funciones:

git checkout -b feature/my-feature

2. Hacer cambios

3. Ejecutar pruebas:

make test

4. Comprometerse:

git add .
git commit -m "Add my feature"

5. Empujar:

git push origin feature/my-feature

6. Crear solicitud de extracción en GitHub

Estilo de código#

Código de formato:

# Black
black .

# isort
isort .

Hilas:

pylint construbot/

Consulte Estilo de código para obtener pautas completas.

Ver también#