First off, thanks for wanting to make this project more based than recursive neural nets fr fr!
- 📝 CHANGELOG.md - What we've done (more organized than my life)
- 🗺️ ROADMAP.md - Where we're going (more planned than my career)
- 🎮 README.md - The tutorial level
- 💭 Check the "Ideas" section in ROADMAP.md for galaxy brain inspiration
-
Pick Your Quest
- Check ROADMAP.md for what's cooking
- Look at open issues (they're like side quests fr fr)
- Got a new idea? Drop an issue like it's hot
-
Setup Your Dev Environment
git clone https://github.com/yourusername/smolswarms.git cd smolswarms pip install -e .[dev] # Install that developer DLC
-
Before Committing
# Run these like you're doing a pre-boss fight checklist ruff check . && black . --check && mypy smolswarms/
-
Creating PRs
- Link to issues like you're connecting dots in a conspiracy board
- Follow the template more precisely than a speedrunner's inputs
- Update CHANGELOG.md - document your W's
- Tag @openhands-agent in issues/PRs (AI helping AI, we really in 2024)
- Check the "Under Construction" section in ROADMAP.md
- Join our Discord for that real-time debug energy
- Check ROADMAP.md to see what's already in the works
- Update CHANGELOG.md with your additions
- Make sure your code's more tested than a Discord bot before release
Remember: We're trying to keep this codebase cleaner than my browser history after clearing cache! 🧹✨
If you're feeling generous fr fr, check out our FUNDING.yml - help us keep the servers running hotter than my GPU during ML training!
No cap, just vibes and clean code! 🚀