Contributing to PyWizardry

• Python 3.7 or higher
• Git installed
• Basic understanding of Python
• GitHub account

# Fork the repository on GitHub
# Visit: https://github.com/saifullah10141/pywizardry

# Clone your fork
git clone https://github.com/YOUR_USERNAME/pywizardry.git
cd pywizardry

# Add upstream remote
git remote add upstream https://github.com/saifullah10141/pywizardry.git

# Create a branch
git checkout -b feature/your-feature-name

# Create virtual environment
python -m venv venv

# Activate virtual environment
# On Windows:
venv\Scripts\activate
# On macOS/Linux:
source venv/bin/activate

# Install development dependencies
pip install -e .[dev]

# Install pre-commit hooks
pre-commit install

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.

Examples of behavior that contributes to a positive environment:

• Using welcoming and inclusive language
• Being respectful of differing viewpoints and experiences
• Gracefully accepting constructive criticism
• Focusing on what is best for the community
• Showing empathy towards other community members

Examples of unacceptable behavior:

• The use of sexualized language or imagery
• Trolling, insulting or derogatory comments
• Public or private harassment
• Publishing others' private information without permission
• Other conduct which could reasonably be considered inappropriate

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at saifullahanwar00040@gmail.com. All complaints will be reviewed and investigated promptly and fairly.

Enforcement Guidelines:

1. Correction: Private, written warning
2. Warning: Public warning with consequences
3. Temporary Ban: Temporary prohibition from interaction
4. Permanent Ban: Permanent prohibition from interaction

• Follow PEP 8 style guide
• Use type hints for all functions
• Write docstrings for all public functions
• Keep functions focused and single-purpose
• Maximum line length: 88 characters
• Use meaningful variable names

"""
New utility function example
"""

from typing import List, Optional
from functools import wraps

def new_utility_function(
    data: List[str],
    option: Optional[str] = None
) -> List[str]:
    """
    Brief description of what the function does.
    
    Args:
        data: List of strings to process
        option: Optional parameter for customization
    
    Returns:
        List[str]: Processed list of strings
    
    Raises:
        ValueError: If input is invalid
    
    Examples:
        >>> new_utility_function(['a', 'b', 'c'])
        ['A', 'B', 'C']
        >>> new_utility_function(['test'], option='upper')
        ['TEST']
    """
    if not data:
        raise ValueError("Data cannot be empty")
    
    # Implementation here
    result = [item.upper() for item in data]
    
    return result

# Add tests in tests/test_module.py
# Update documentation in docs/
# Add examples in examples/

PyWizardry documentation includes:

1. Docstrings

def example_function(param1: str, param2: int = 10) -> bool:
    """
    Brief description of function.
    
    Extended description explaining details, examples,
    and edge cases.
    
    Args:
        param1: Description of first parameter
        param2: Description of second parameter (default: 10)
    
    Returns:
        bool: Description of return value
    
    Raises:
        ValueError: When something goes wrong
    
    Examples:
        >>> example_function("test", 20)
        True
        >>> example_function("invalid")
        False
    """
    # Function implementation
    return True

2. README Updates

Update README.md with:

• New features
• Usage examples
• Installation instructions
• Configuration options

3. API Documentation

Update API reference in docs/api/ directory.

# tests/test_example.py
import pytest
from pywizardry import example_module

def test_basic_functionality():
    """Test basic functionality."""
    result = example_module.example_function("test")
    assert result is True

def test_with_parameters():
    """Test with different parameters."""
    result = example_module.example_function("test", 20)
    assert result is True

def test_edge_cases():
    """Test edge cases."""
    with pytest.raises(ValueError):
        example_module.example_function("")

def test_async_function():
    """Test async functions."""
    import asyncio
    result = asyncio.run(example_module.async_function())
    assert result == expected_value

@pytest.mark.parametrize("input,expected", [
    ("a", "A"),
    ("b", "B"),
    ("c", "C"),
])
def test_parametrized(input, expected):
    """Parametrized test."""
    result = example_module.process(input)
    assert result == expected

# Generate coverage report
pytest --cov=pywizardry --cov-report=html

# Minimum coverage requirement: 90%
# View report: open htmlcov/index.html