Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 679 Bytes

CONTRIBUTING.md

File metadata and controls

34 lines (26 loc) · 679 Bytes

Contributing to SCSM

Issues and Feature Requests

  • Check if an there is an existing issue (open or closed).
  • Use the issue and feature templates.
  • Issues are not for support questions.

Pull Requests

  • Open a pull request as soon as possible.
    • Avoids duplicate work.
    • Can be review and discussed early.
    • Mark [WIP] if not ready to be pulled.
  • Use the pull request template.

Developing

Install SCSM for development:

git clone --recurse-submodules https://github.com/bubylou/scsm.git
cd scsm
poetry install

Run code style checks:

poetry run ruff --line-lenth 100

Run tests which also does a code style check:

poetry run pytest