Skip to content

Add PocketPay SDK test-first contribution guide #425

Description

@El-swaggerito

Description

Difficulty: Expert

Type: Documentation

Summary

Create a test-first contribution guide for PocketPay SDK.

Current Behaviour

Contributors may update wallet helpers, payment builders, transaction utilities, vault helpers, config, and SDK errors without adding meaningful tests.

Expected Behaviour

The repo should explain when tests are required, what type of tests are expected, and how contributors should prove the behaviour works.

Suggested Implementation

Add documentation with testing examples, no-test justification rules, negative-path expectations, and local commands.

Files or Areas Likely Affected

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

Acceptance Criteria

  • Test-first contribution guide is added.
  • Testing expectations for wallet helpers, payment builders, transaction utilities, vault helpers, config, and SDK errors are documented.
  • Happy-path and negative-path test expectations are included.
  • No-test justification rules are documented.
  • Local test commands are included.
  • README links to the guide.

Additional Notes

This addresses under-tested merged PRs.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked for GrantFox OSS contributionMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Official GrantFox campaign labeldeveloper-experienceDeveloper experience workdocumentationDocumentation 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