Skip to content

Add SDK CI-required local verification workflow #374

Description

@El-swaggerito

Description

Difficulty: Expert

Type: CI

Summary

Add a local verification workflow that mirrors the expected CI checks for SDK contributors.

Current Behaviour

Contributors may rely on GitHub CI only after opening a PR, or submit work without running checks locally.

Expected Behaviour

The SDK repo should provide one documented command that runs lint, typecheck, tests, and coverage where available.

Suggested Implementation

Add package scripts, documentation, and optional CI workflow notes for local verification.

Files or Areas Likely Affected

  • package.json
  • docs/
  • README.md
  • .github/
  • tests/

Acceptance Criteria

  • A local verification command is added.
  • The command runs relevant checks.
  • Documentation explains when to run it.
  • Failure handling guidance is included.
  • README links to the workflow.
  • CI expectations are aligned with local commands.

Additional Notes

This helps contributors avoid failing CI.

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked for GrantFox OSS contributionMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Official GrantFox campaign labelciCI and workflow workdeveloper-experienceDeveloper experience workexpertExpert difficultysdkSDK related worktestTesting work

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions