Skip to content

GITHUB_CHECKLIST.md

Latest commit

 

History

History
194 lines (151 loc) · 4.41 KB

GITHUB_CHECKLIST.md

File metadata and controls

194 lines (151 loc) · 4.41 KB

GitHub Upload Checklist

✅ Files Ready for GitHub

Core Files

  • portkiller.py - Main script (197 lines)
  • README.md - Full documentation with badges
  • LICENSE - MIT License (update with your name)
  • requirements.txt - Python dependencies
  • .gitignore - Python-specific ignores

Documentation

  • INSTALL.md - Installation guide
  • CONTRIBUTING.md - Contribution guidelines
  • PROJECT_STATS.md - Build stats (optional, can keep or remove)

Examples & Tests

  • examples/usage_examples.sh - Quick reference
  • examples/common_ports.md - Port reference
  • examples/test_portkiller.py - Integration test

GitHub Automation

  • .github/workflows/ci.yml - CI/CD pipeline

Before Pushing to GitHub

1. Update LICENSE

Replace [Your Name] in LICENSE with your actual name:

Copyright (c) 2025 YOUR NAME HERE

2. Update README

Replace YOUR-USERNAME in README.md with your GitHub username:

git clone https://github.com/YOUR-USERNAME/portkiller.git

3. Update INSTALL.md

Same as above - replace YOUR-USERNAME with your GitHub username.

4. Test Everything

# Test basic functionality
python portkiller.py 9999

# Run integration test
python examples/test_portkiller.py

# Make sure examples work
chmod +x examples/usage_examples.sh
./examples/usage_examples.sh

Git Commands to Push

# Initialize repo (if not already done)
git init

# Add all files
git add .

# Create initial commit
git commit -m "Initial commit: Port Killer - Day 5 of 30 for 30"

# Create main branch
git branch -M main

# Add your GitHub repo as remote
git remote add origin https://github.com/YOUR-USERNAME/portkiller.git

# Push to GitHub
git push -u origin main

After Pushing

1. Create GitHub Repository

  • Go to https://github.com/new
  • Name: portkiller or port-killer
  • Description: "Find and kill processes hogging your ports. No more 'port already in use' errors."
  • Public repository
  • DO NOT initialize with README (you already have one)

2. Add Topics (Tags)

On your GitHub repo page, add these topics:

  • python
  • cli
  • developer-tools
  • port-management
  • productivity
  • devtools
  • cross-platform

3. Enable GitHub Actions

  • Go to "Actions" tab
  • Enable workflows
  • CI will run automatically on push/PR

4. Add Repository Details

In your repo settings, add:

  • Website: Link to your blog post (if you write one)
  • Description: "Kill processes hogging ports. Because 'port 3000 already in use' is rage-inducing."

5. Create Releases (Optional)

  • Go to "Releases" → "Create a new release"
  • Tag: v1.0.0
  • Title: "Port Killer v1.0.0"
  • Description: Initial release features

Optional Enhancements

Add a Demo GIF

Record a terminal session using asciinema or create a GIF:

# Start recording
asciinema rec demo.cast

# Use the tool
python portkiller.py 3000 -f

# Stop recording
exit

# Convert to GIF and add to README

Create a Website

Use GitHub Pages to host documentation:

# Enable GitHub Pages in repo settings
# Use /docs folder or main branch

Add More Badges

In README.md, add:

  • Code coverage badge
  • PyPI version (if you publish to PyPI)
  • Downloads count
  • Last commit date

Directory Structure (What's Being Uploaded)

portkiller/
├── .github/
│   └── workflows/
│       └── ci.yml
├── examples/
│   ├── common_ports.md
│   ├── test_portkiller.py
│   └── usage_examples.sh
├── .gitignore
├── CONTRIBUTING.md
├── INSTALL.md
├── LICENSE
├── PROJECT_STATS.md
├── README.md
├── portkiller.py
└── requirements.txt

Post-Upload Promotion

Share It

  • Twitter/X: "Built a tool to kill those annoying 'port already in use' processes. Check it out!"
  • Reddit: r/Python, r/programming, r/webdev
  • Dev.to: Write a blog post
  • Hacker News: If it gets traction
  • Your blog: Write the full "Day 5" post

Monitor

  • Watch for issues
  • Respond to PRs
  • Update based on feedback

Remember

  • Star your own repo (tradition)
  • Add it to your portfolio
  • Link to it from your 30 for 30 project list
  • Use it yourself regularly

You're ready to push to GitHub! 🚀

Just remember to update:

  1. Your name in LICENSE
  2. Your GitHub username in README.md and INSTALL.md
  3. Test everything one more time

Then run those git commands above and you're live!