Skip to content

Latest commit

 

History

History
85 lines (61 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

85 lines (61 loc) · 1.35 KB

Contributing to 0xBuilder MEV Bot 🤖

Welcome! We're excited that you want to contribute to 0xBuilder! 🎉

Quick Start

  1. Fork & Clone
git clone https://github.com/John0n1/0xbuilder.git
cd 0xBuilder
  1. Set Up
python3 -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate
pip install -r requirements.txt
  1. Configure
cp .env.example .env
# Fill in your API keys

What You Need 🛠️

  • Python 3.12+
  • Git
  • Ethereum node access
  • Some API keys (Infura, Etherscan, etc.)
  • A test wallet

How to Help 🤝

Found a Bug? 🐛

Open an issue! Tell us:

  • What happened
  • What should have happened
  • Steps to reproduce

Have an Idea? 💡

We love new ideas! Open an issue and tell us about your feature suggestion.

Want to Code? 👩‍💻👨‍💻

  1. Create a branch
git checkout -b feature/cool-new-thing
  1. Code away!
  • Keep it simple
  • Add tests
  • Update docs if needed
  1. Submit a PR
  • Clear title and description
  • Link related issues

Style Guide 📝

  • Follow PEP 8
  • Use type hints
  • Max 88 chars per line
  • Clear variable names

Testing 🧪

pytest tests/

Questions? 💬

  • Open an issue
  • Join our community discussions

License 📄

MIT Licensed. Code away! 🚀

Remember: Keep it simple, have fun, and happy coding! 🎮