💻 Open Source Bug Fix Template

How to quickly report and fix issues in open source projects

# Open Source Bug Report & Fix Template

# 1. Create a clear issue report
def create_bug_report(title, description, steps_to_reproduce, expected_behavior, actual_behavior):
    """
    Template for effective bug reporting in open source projects
    """
    report = f"""
    ## Bug Report: {title}
    
    **Description:**
    {description}
    
    **Steps to Reproduce:**
    {steps_to_reproduce}
    
    **Expected Behavior:**
    {expected_behavior}
    
    **Actual Behavior:**
    {actual_behavior}
    
    **Environment:**
    - OS: [e.g., Ubuntu 22.04]
    - Version: [e.g., v1.2.3]
    - Python: [e.g., 3.9]
    """
    return report

# 2. Quick fix contribution workflow
def contribute_fix(fork_url, branch_name, fix_description):
    """
    Basic workflow for contributing a fix to open source
    """
    steps = [
        "# Fork the repository",
        f"git clone {fork_url}",
        f"git checkout -b fix/{branch_name}",
        "# Make your changes",
        "git add .",
        f"git commit -m 'Fix: {fix_description}'",
        "git push origin fix/{branch_name}",
        "# Create pull request on GitHub"
    ]
    return '\n'.join(steps)

# 3. Example: Simple bug fix pattern
def fix_common_bug(buggy_code, fixed_code):
    """
    Example pattern for common bug fixes
    """
    print(f"Before fix:\n{buggy_code}")
    print(f"\nAfter fix:\n{fixed_code}")
    print("\n# Test your fix with:")
    print("pytest tests/ -v")
    print("# Or run specific test:")
    print("python -m pytest tests/test_module.py::test_function")

# Usage example
if __name__ == "__main__":
    # Example bug report
    report = create_bug_report(
        title="API endpoint returns 500 on empty payload",
        description="POST request with empty JSON crashes server",
        steps_to_reproduce="1. Send POST to /api/data with {}\n2. Observe 500 error",
        expected_behavior="Should return 400 Bad Request",
        actual_behavior="Returns 500 Internal Server Error"
    )
    print(report)