Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (37 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 1.3 KB
Raw

Contributing

Thank you for your interest in contributing to QUADS Client!

Getting Started

  1. Fork the repository (uncheck only main branch)
  2. Checkout development branch
git checkout development
git checkout -b mybranch
  1. Make your changes following DRY principles
  2. Format code with black (line-length 119)
  3. Test thoroughly and push your local changes.
git push -u origin mybranch
  1. Submit a pull request to the development branch

Code Standards

  • Follow DRY (Don't Repeat Yourself) principles
  • Use black for code formatting with line-length 119
  • Write tests for new functionality
  • Maintain or improve test coverage (currently 73%+)
  • Keep code simple and maintainable

Testing

  • You can use the following command to run quads-client directly from the repository:
PYTHONPATH=src python3 -c "from quads_client.shell import QuadsClientShell; shell = QuadsClientShell(); shell.cmdloop()"

Before submitting a pull request, ensure:

# Run tests with coverage
python -m pytest --cov=src/quads_client --cov-report=term-missing -v

# Check code style
python -m flake8 src/ tests/ --count --max-line-length=119 --statistics

Questions?