Skip to content

docs: add CONTRIBUTING.md - #103

Merged
petercorke merged 1 commit into
mainfrom
docs/contributing
Oct 3, 2026
Merged

petercorke merged 1 commit into
mainfrom
docs/contributing

Conversation

@petercorke

Copy link
Copy Markdown
Owner

Summary

MVTB never had a CONTRIBUTING.md. Adds one, structured the same way as the rewritten RTB/bdsim versions (companion PRs), filled in with MVTB's actual setup:

  • Tooling: ruff (lint/import-sort) + black (format) + pyright (type checking) -- confirmed via pyproject.toml
  • Real CI test command (python -m pytest --timeout=50 --timeout-method=thread)
  • Conventional Commits PR-title note (commitlint.yml already enforces it)
  • Pointer to good first issue/help wanted labels

Test plan

  • Verified tooling (ruff/black/pyright) via pyproject.toml
  • Verified commitlint.yml exists and actually checks PR titles
  • Verified good first issue/help wanted labels exist

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

MVTB never had one. Same structure as RTB/bdsim's rewritten versions (companion PRs), filled in with MVTB's actual tooling: ruff+black+pyright, and its real CI test command.
@petercorke
petercorke merged commit 81af66e into main Oct 3, 2026
29 checks passed
@petercorke
petercorke deleted the docs/contributing branch October 3, 2026 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant