Contributing#

Guidelines for contributing to ops-db-api.

Getting Started#

  1. Fork the repository

  2. Create a feature branch

  3. Make your changes

  4. Write tests

  5. Submit a pull request

Code Style#

  • Follow PEP 8

  • Use type hints

  • Write docstrings

  • Format with black: black ccat_ops_db_api/

  • Lint with ruff: ruff check ccat_ops_db_api/

Testing#

All contributions must include tests:

pytest
pytest --cov=ccat_ops_db_api

Documentation#

Update documentation for:

  • New endpoints

  • Configuration changes

  • API changes

  • Breaking changes

Pull Request Process#

  1. Ensure tests pass

  2. Update documentation

  3. Add entry to CHANGELOG

  4. Request review

  5. Address feedback

  6. Await approval and merge

Questions#

For questions, open an issue on GitHub or contact the maintainers.