Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
103 lines (68 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

103 lines (68 loc) · 2.56 KB

Contributing to LeetCode Practice Repository

Thank you for your interest in contributing! This repository welcomes contributions from the community.

Ways to Contribute

1. Add New Problems

For adding new LeetCode problems, please refer to the comprehensive guide:

📖 LLM-Assisted Problem Creation Guide

This document provides detailed instructions for using LLM assistants to generate new problems with proper templates, test cases, and documentation.

Acceptance Criteria:

  • All GitHub Actions CI checks must pass (includes linting, testing, security scanning, reproducibility verification, and minimum 10 test cases per problem)
  • Proper type hints and code formatting
  • Complete the solution (documentation is auto-generated)

2. Other Contributions

All other contributions are welcome! This includes:

  • Bug fixes and improvements
  • Documentation enhancements
  • Helper class improvements
  • CI/CD workflow enhancements
  • Test case enhancements
  • New data structure visualizations

For small changes: Feel free to open a pull request directly.

For larger changes: Please open an issue for discussion first.

I'm also open to feedback and suggestions for improving the project!

Development Setup

Prerequisites

  • Python 3.10+ - Modern Python runtime
  • uv - Fast Python package manager (install guide)
  • Bake - Modern task runner
  • Git - Version control
  • Graphviz - Graph visualization (install guide)

Development Workflow

1. Fork and Setup

# Fork the repository on GitHub, then clone your fork
git clone https://github.com/YOUR_USERNAME/leetcode-py.git
cd leetcode-py
uv sync

# Add upstream remote
git remote add upstream https://github.com/wislertt/leetcode-py.git

# Verify setup
bake test
bake lint

2. Create Feature Branch

git checkout -b your-feature-name

3. Make Changes and Test

# Test specific problem
bake p-test -p problem_name

# Test all
bake test

# Lint your changes
bake lint

# Generate/regenerate problems (if needed)
bake p-gen -p problem_name

4. Submit Pull Request

# Commit and push to your fork
git add .
git commit -m "feat: your descriptive commit message"
git push origin your-feature-name

# Then create a pull request on GitHub from your fork to the main repository

Ensure all GitHub Actions CI checks pass before requesting review.

Questions?

Open an issue for questions or discussions about contributions.