Skip to content

Contributing

Development Setup

git clone https://github.com/your-org/timeseries-qc.git
cd timeseries-qc
pip install -e ".[dev]"

Running Tests

pytest tests/

Adding a New Rule

  1. Create a class in tsqc/rules/ that extends Rule
  2. Implement apply(tag_df: pd.DataFrame) -> RuleResult
  3. Register in tsqc/rules/__init__.py
  4. Add tests in tests/test_rules.py

Code Style

  • Follow PEP 8
  • Type hints for all public functions
  • Docstrings for all public classes and methods

Brand & Design

Visual identity (logo, colors, typography, social cards, report chrome) is documented in the Design System.

When changing docs UI, README badges, HTML reports, or marketing images:

  1. Follow Design System tokens and do/don’t rules
  2. Rebuild assets with python scripts/build_brand_assets.py and python scripts/generate_social_preview.py when the logo or social card changes
  3. Keep Material indigo for docs accents; keep Plotly chart colors unless the change is intentional and documented

Pull Request Process

  1. Fork the repository
  2. Create a feature branch
  3. Add tests for your changes
  4. Ensure all tests pass
  5. Submit a pull request

Reporting Issues

Report bugs and feature requests at:

https://github.com/nagusubra/timeseries-qc/issues

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Next Steps