TheVicky1 / TheVicky1/Pact_OS

[Docs] Add LeetCode API Payload Example to Proof Connector Spec

Open Beginner friendly
#54 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

accessibility area:core beginner friendly bug community contributions-welcome difficulty:beginner difficulty:easy documentation enhancement good first issue hacktoberfest help wanted time:<15m up-for-grabs
Dominant language
TypeScript
Stars
5
Forks
7
Avg merge
39m
Merged PRs (30d)
39

Description

  • Labels: good first issue, documentation, difficulty:beginner, area:core
  • Target File: docs/INTEGRATIONS.md
  • Estimated Time: 5–10 minutes
  • Difficulty: Level 1 (Beginner)
Why This Matters

PACT verifies proof-of-work accountability through external platforms like LeetCode and GitHub. Providing a concrete mock JSON payload in docs/INTEGRATIONS.md helps contributors understand how verification data is parsed without needing live API tokens.

Current Behavior

docs/INTEGRATIONS.md describes the LeetCode GraphQL connector conceptually, but does not include a sample GraphQL JSON response for submission verification.

Requested Change

Add a fenced JSON code block in docs/INTEGRATIONS.md under the LeetCode section showing a sample GraphQL response payload containing recentSubmissionList with titleSlug, statusDisplay: "Accepted", and timestamp.

Acceptance Criteria
  • Sample JSON payload block added to docs/INTEGRATIONS.md.
  • JSON is valid and matches the fields handled in src/lib/integrations/leetcode.ts.
Verification
node scratch/check-links.mjs
Contributor Notes

Documentation-only task.


Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the LeetCode section in docs/INTEGRATIONS.md and compare its described fields with src/lib/integrations/leetcode.ts. Add a valid fenced JSON example containing recentSubmissionList, titleSlug, statusDisplay set to "Accepted", and timestamp. Run node scratch/check-links.mjs and confirm the acceptance criteria are met.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
95/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.