Getting Started#

First steps for contributing to Construbot.

Prerequisites#

Required:

Git
Python 3.9.17+
Docker and Docker Compose (recommended)

Or for local development:

PostgreSQL 12+
Redis 6+
Virtual environment

Fork and Clone#

1. Fork repository:

Visit https://github.com/javier-llamas/construbot and click “Fork”

2. Clone your fork:

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

3. Add upstream remote:

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

Development Setup#

Using Docker (Recommended):

# Build and start
make buildev

# Create superuser
make superuser

# Run tests
make test

Using Local Environment:

# 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

Making Changes#

1. Create feature branch:

git checkout -b feature/my-feature

2. Make changes

3. Run tests:

make test

4. Commit:

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

5. Push:

git push origin feature/my-feature

6. Create Pull Request on GitHub

Code Style#

Format code:

# Black
black .

# isort
isort .

Lint:

pylint construbot/

See Code Style for complete guidelines.