Skip to content

Latest commit

 

History

History
26 lines (16 loc) · 991 Bytes

CONTRIBUTING.md

File metadata and controls

26 lines (16 loc) · 991 Bytes

🤝 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 NPM for package management. Please make sure you have it installed before proceeding.

  1. Fork the repo and create your branch from master.
  2. Run npm install in the repository root.
  3. Run npm run dev to start the development server.
  4. Make your changes!

✅ Linting and Type Checking

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

npm 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.