Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (45 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

65 lines (45 loc) · 1.63 KB

Contributing

Thanks for your interest in contributing to GeM BidPlus Automation!

Getting started

  1. Fork the repository
  2. Clone your fork and create a feature branch:
git clone https://github.com/YOUR_USERNAME/gem-automation.git
cd gem-automation
git checkout -b feature/your-feature
  1. Set up the development environment:
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install ruff
patchright install chromium
  1. Copy .env.example to .env and fill in test credentials

Code style

We use Ruff for formatting and linting. Please run it before committing:

# Format code
ruff format .

# Check for lint errors
ruff check .

CI will reject pull requests that fail the formatting or lint check.

Making changes

  • Follow the existing code style and project structure
  • All flows inherit from BaseFlow and implement run(page, **kwargs)
  • Selectors and timeouts go in config.yaml, not hardcoded in Python
  • Secrets must come from environment variables, never from code or config files

Submitting a pull request

  1. Run ruff format . and ruff check . before pushing
  2. Make sure your changes work end-to-end
  3. Keep commits focused — one logical change per commit
  4. Write clear commit messages
  5. Push to your fork and open a pull request against main

Reporting issues

  • Use GitHub Issues
  • Include the error traceback, your Python version, and OS
  • If possible, include a screenshot or the debug HTML/HAR from debug_logs/

Code of conduct

Be respectful and constructive. We're all here to build something useful together.