Thank you for considering contributing to opencode-ip-rotator. Please read through these guidelines to maintain project quality.
- Python: Follow PEP 8 guidelines. Write clean, readable code with type hints where appropriate.
- Microservices Integrity: Maintain clear separation of concerns between
proxy-server(request handling & metrics) andwarp-rotator(WARP daemon & networking). - No Direct Exception Swallowing: Always log exceptions with context (
log.error) instead of passing silently.
- Fork the repository and create a new feature branch from
master. - Make your changes and test using
python test.pyanddocker compose up -d --build. - Commit with concise, descriptive commit messages (e.g.
feat: add retry backoff logic,fix: resolve SQLite lock issue). - Submit a Pull Request targeting the
masterbranch with a summary of changes.
- Do not commit local environment files, SQLite databases (
.db), or private API keys. - Ensure
.gitignorerules are respected before pushing.