Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

65 lines (44 loc) · 1.8 KB

🤝 Contributing to zksync-js

Thanks for your interest in contributing! 🎉
This project is open to bug fixes, features, documentation, and examples.

🛠 Getting Started

  1. Fork & clone this repo

    git clone git@github.com:YOURNAME/zksync-js.git
cd zksync-js

  2. Install dependencies

    bun install

  3. Run tests to verify everything works

    bun run test

📖 Contribution Types

  • Bug reports – open a GitHub issue with clear steps to reproduce.
  • Fixes / features – open a pull request. Keep changes focused.
  • Docs / examples – improvements are always welcome!

✅ Pull Request Checklist

Before submitting a PR, please make sure:

  • Commits are small and meaningful.

  • bun run test passes locally.

  • Run code checks to ensure style and types are correct:

    bun run lint
bun run format:check
bun run typecheck

  • Update or add docs/examples if needed. For docs, make sure to import any code examples from tests inside docs/snippets. Use ANCHOR comments with unique tags to specify a code block within a test to import into a markdown file. For more information, check out the mdbook docs.

  • Link the related issue (if any).

🤖 AI-Assisted Development

If you're using AI tools (Claude, ChatGPT, Cursor, etc.) to contribute:

💬 Questions?

Thanks again for helping improve zksync-js! 🚀