Contributing to YASB

Thank you for your interest in contributing to YASB! This guide will help you get started with the development workflow and coding standards.

Getting Started

Prerequisites

  • Python 3.12
  • Git
  • A Windows development environment (YASB is Windows-only)

Setting up Development Environment

  1. Fork and Clone the Repository bash git clone https://github.com/amnweb/yasb.git cd yasb

  2. Install Development Dependencies bash pip install -e .[dev]

  3. Install Pre-commit Hooks bash pre-commit install

  4. VS Code Setup (Recommended) The project includes VS Code workspace configuration in .vscode/:

  • Recommended Extensions (.vscode/extensions.json):

    • charliermarsh.ruff - Ruff linter and formatter
    • ms-python.python - Python language support
    • ms-python.vscode-pylance - Advanced Python IntelliSense
    • ms-python.debugpy - Python debugging

  • Workspace Settings (.vscode/settings.json):

    • Excludes __pycache__ directories from file explorer and search
    • Configures Ruff as the default Python formatter
    • Enables auto-fix and import organization on save

    VS Code will automatically suggest installing the recommended extensions when you open the project.

Development Workflow

Code Quality Tools

YASB uses several tools to maintain code quality:

  • Ruff: Fast Python linter and formatter
  • Pre-commit: Git hooks for automated code quality checks
  • GitHub Actions: Automated CI/CD workflows

Pre-commit Configuration

The .pre-commit-config.yaml includes: - Ruff linting and formatting with auto-fix enabled

Linting and Formatting

Before committing your changes:

# Format code with Ruff
ruff format .

# Check linting
ruff check .

# Fix auto-fixable issues
ruff check --fix .

Project Structure

yasb/
├── src/
│   ├── core/
│   │   ├── widgets/         # Widget implementations
│   │   └── validation/      # Widget validation schemas
│   ├── config.yaml          # Default configuration
│   ├── styles.css           # Default styles
│   └── main.py              # Application entry point
├── docs/                    # Documentation
├── demo/                    # Demo images
├── .github/                 # GitHub workflows and templates
├── pyproject.toml           # Project configuration
└── README.md

Contributing Guidelines

Types of Contributions

  1. Bug Fixes: Fix existing issues
  2. New Widgets: Add new widget functionality
  3. Documentation: Improve or add documentation
  4. Performance: Optimize existing code
  5. Features: Add new application features

Creating a New Widget

Follow the Writing Widget guide for detailed instructions.