Skip to content

Comments

ci: add lint step to CI workflow and improve documentation#7

Open
dolepee wants to merge 1 commit intocirclefin:masterfrom
dolepee:ci-lint-and-docs
Open

ci: add lint step to CI workflow and improve documentation#7
dolepee wants to merge 1 commit intocirclefin:masterfrom
dolepee:ci-lint-and-docs

Conversation

@dolepee
Copy link

@dolepee dolepee commented Feb 7, 2026

Summary

This PR adds the missing lint step to the CI workflow and improves project documentation.

Changes

  1. CI workflow — Added npm run lint step after dependency installation. The job is named lint-and-test but was only installing dependencies without running the linter.
  2. deposit.ts documentation — Replaced the sparse TODO comment for Circle Paymaster API integration with a detailed JSDoc comment explaining the planned integration steps.
  3. CONTRIBUTING.md — Added contribution guidelines covering development setup, PR process, and coding standards.

Why

  • The CI lint-and-test job should actually run the linter to catch issues before merge
  • Detailed documentation on planned integrations helps contributors understand the roadmap
  • Contribution guidelines reduce friction for new contributors

- Add npm run lint step to CI workflow after dependency installation
- Add detailed JSDoc comment for planned Circle Paymaster API integration in deposit.ts
- Add CONTRIBUTING.md with development setup and contribution guidelines
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