Development

​

Getting Started

# Clone the repository
git clone https://github.com/TheHandsomeDev/evolveRL.git
cd evolveRL

# Create a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: .\venv\Scripts\activate

# Install dependencies
pip install -e ".[dev]"

​

Development Setup

1. Fork the Repository
   • Visit evolveRL on GitHub
   • Click the “Fork” button to create your copy of the repo
2. Create a Branch
   Copy

   git checkout -b feature/your-feature-name
   

​

Pull Request Process

1. Update Your Fork
   Copy

   git remote add upstream https://github.com/TheHandsomeDev/evolveRL.git
   git fetch upstream
   git merge upstream/main
   

2. Push Changes
   Copy

   git push origin feature/your-feature-name
   

3. Create Pull Request
   • Go to the evolveRL repository
   • Click “New Pull Request”
   • Select your branch
   • Fill out the PR template

​

Development Guidelines

1. Code Style
   • Follow PEP 8 guidelines
   • Use type hints
   • Write descriptive docstrings
   • Keep functions focused and modular
2. Documentation
   • Update relevant documentation
   • Include docstrings for public APIs
   • Add examples for new features
3. Commit Messages
   • Use clear, descriptive commit messages
   • Reference issues when applicable
   • Follow conventional commits format

​

Getting Help

• Join our Telegram community
• Check existing GitHub issues