First off โ thank you for checking out ForkMonkey! Whether you're here to adopt a monkey, breed rare traits, or hack on the code, you're part of the family now.
The easiest way to contribute is to fork this repo and let your monkey join the network!
- Your monkey inherits traits from this repo's monkey
- It evolves daily via AI (GitHub Actions + GitHub Models)
- Your fork appears on the global Family Tree
Pro tip: Fork a monkey with rare traits to give your child a better starting gene pool!
Stars help us grow and attract more breeders to the network. More monkeys = more fun!
Found something broken? Open an issue using our Bug Report template.
Have an idea? We love hearing them. Use the Feature Request template.
Want to breed your monkey with a specific parent? Open a Breed Request.
Want to hack on the evolution engine, visualizer, or genetics system? Here's how:
# Clone your fork
git clone https://github.com/YOUR_USERNAME/forkMonkey.git
cd forkMonkey
# Install dependencies
pip install -r requirements.txt
# Initialize a test monkey
python src/cli.py init
# Run the web UI locally
./start_web.sh
# Run tests
pytest tests/| Area | File(s) | Description |
|---|---|---|
| ๐ง AI Evolution | src/evolution.py |
Add new AI providers (Ollama, HuggingFace, etc.) |
| ๐จ Visualizer | src/visualizer.py |
Add new traits, body parts, accessories |
| ๐งฌ Genetics | src/genetics.py |
Tweak mutation rates, add new trait categories |
| ๐ Web UI | web/ |
Improve the dashboard, add features |
| ๐ Workflows | .github/workflows/ |
Improve automation, CI/CD |
- Fork the repo and create a feature branch (
feature/my-awesome-thing) - Write tests if applicable
- Ensure
pytest tests/passes - Open a PR with a clear description of what you changed and why
Contributors who make significant PRs get:
- ๐๏ธ Shoutout in the README
- ๐งฌ A special "contributor" trait added to their monkey (coming soon!)
Be kind. Be helpful. Don't be a jerk. We're all here to have fun breeding digital monkeys. ๐ต
Every fork, star, issue, and PR helps this weird little experiment grow. Let's see how big this family tree can get!