CONTRIBUTING.md

🤝 Contributing to zksync-sdk

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 [email protected]:YOURNAME/zksync-sdk.git
   cd zksync-sdk

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.

• Link the related issue (if any).

💬 Questions?

• Open a GitHub Discussion
• Or join the zkSync community for general questions.

Thanks again for helping improve zksync-sdk! 🚀