Skip to content

Latest commit

ย 

History

History
102 lines (66 loc) ยท 3.38 KB

File metadata and controls

102 lines (66 loc) ยท 3.38 KB

๐Ÿต Contributing to ForkMonkey

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.


๐Ÿด Ways to Contribute

1. Fork & Breed (The Fun Way)

The easiest way to contribute is to fork this repo and let your monkey join the network!

Fork ForkMonkey

  • 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!


2. โญ Star the Repo

Stars help us grow and attract more breeders to the network. More monkeys = more fun!

Star ForkMonkey


3. ๐Ÿ› Report Bugs

Found something broken? Open an issue using our Bug Report template.


4. ๐Ÿ’ก Suggest Features

Have an idea? We love hearing them. Use the Feature Request template.


5. ๐Ÿงฌ Breed Requests

Want to breed your monkey with a specific parent? Open a Breed Request.


6. ๐Ÿ”ง Code Contributions

Want to hack on the evolution engine, visualizer, or genetics system? Here's how:

Quick Start

# 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/

Key Areas to Contribute

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

Pull Request Guidelines

  1. Fork the repo and create a feature branch (feature/my-awesome-thing)
  2. Write tests if applicable
  3. Ensure pytest tests/ passes
  4. Open a PR with a clear description of what you changed and why

๐Ÿ† Hall of Fame

Contributors who make significant PRs get:

  • ๐ŸŽ–๏ธ Shoutout in the README
  • ๐Ÿงฌ A special "contributor" trait added to their monkey (coming soon!)

๐Ÿ“œ Code of Conduct

Be kind. Be helpful. Don't be a jerk. We're all here to have fun breeding digital monkeys. ๐Ÿต


๐Ÿ™ Thank You!

Every fork, star, issue, and PR helps this weird little experiment grow. Let's see how big this family tree can get!

Live Demo