Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1.09 KB

CONTRIBUTING.md

File metadata and controls

28 lines (18 loc) · 1.09 KB
Raw

🤝 Contributing

We're excited that you're interested in contributing to this project! Before submitting your contribution, please read through the following guide.

🔧 Setup

This project uses PNPM for package management. Please make sure you have it installed before proceeding.

  1. Fork the repo and create your branch from master.
  2. Run pnpm install in the repository root.
  3. Run pnpm dev to start the development server.
  4. Click "Install" on the popup to install the development script.
  5. Make your changes!

✅ Linting and Type Checking

This project uses ESLint and TypeScript for linting and type checking, respectively. Please make sure your code passes both before submitting a PR.

pnpm run lint
pnpm run test

📝 Commit Message Format

This project follows the Conventional Commits specification. Please make sure your commit messages are formatted correctly.

Please mention the issue number in the commit message or the PR description.