Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
98 lines (71 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

98 lines (71 loc) · 2.11 KB

Contributing to Port Killer

Thanks for your interest in contributing! This is a simple tool, so we'll keep it simple.

How to Contribute

  1. Fork the repo
  2. Create a branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Test it (make sure it still works!)
  5. Commit (git commit -m 'Add amazing feature')
  6. Push (git push origin feature/amazing-feature)
  7. Open a Pull Request

Guidelines

Keep It Simple

This tool is intentionally minimal. Before adding features, ask:

  • Does this solve a real problem?
  • Can it be done in <50 lines?
  • Will it work cross-platform?

Code Style

  • Follow existing code style
  • Use descriptive variable names
  • Add comments for non-obvious logic
  • Keep functions small and focused

Testing

Before submitting:

# Test basic functionality
python portkiller.py 8888
python portkiller.py 8888 --force
python portkiller.py 8888 --verbose

# Run the integration test
python examples/test_portkiller.py

What We're Looking For

Good PRs:

  • Bug fixes
  • Performance improvements
  • Better error messages
  • Cross-platform compatibility fixes
  • Documentation improvements

PRs We'll Probably Reject:

  • Massive feature additions that change the scope
  • Dependencies that aren't cross-platform
  • Anything that makes the code significantly more complex

Reporting Bugs

Open an issue with:

  • What you tried to do
  • What happened
  • What you expected to happen
  • Your OS and Python version
  • Output from running with --verbose

Suggesting Features

Open an issue with:

  • The problem you're trying to solve
  • Why existing functionality doesn't work
  • How you envision it working
  • Whether you're willing to implement it

Development Setup

# Clone your fork
git clone https://github.com/YOUR-USERNAME/portkiller.git
cd portkiller

# Install dependencies
pip install -r requirements.txt

# Make it executable
chmod +x portkiller.py

# Test it
python portkiller.py 9999

Questions?

Open an issue! We're friendly. Mostly.

License

By contributing, you agree your contributions will be licensed under the MIT License.