Skip to content

contributing.md

Latest commit

 

History

History
40 lines (29 loc) · 1.15 KB

contributing.md

File metadata and controls

40 lines (29 loc) · 1.15 KB
Raw

Contributing

Contributions are welcome, especially focused fixes, tests, documentation improvements, and new registry-backed methods.

Before Opening A Pull Request

  1. Start from main or the target release branch.
  2. Keep changes scoped to the phase or feature being changed.
  3. Add or update tests for behavior changes.
  4. Update docs, configs, or notebooks when parameter names or user workflows change.
  5. Run the relevant tests locally.

Useful Checks

pytest streamline/tests/test_complete_binary.py
pytest streamline/tests/test_complete_multiclass.py
pytest streamline/tests/test_complete_regression.py
sphinx-build -b html docs/source docs/build/html

Documentation Contributions

When updating docs:

  • Prefer current P1-P11 phase names.
  • Keep config names, CLI names, and notebook names aligned.
  • Avoid reintroducing outdated phase names.
  • Update sample_runcommands.txt and run_configs/ if examples change.

Reporting Bugs

When reporting a bug, include:

  • STREAMLINE branch or commit
  • operating system and Python version
  • command or config used
  • traceback or warning output
  • a minimal dataset/config example when possible