Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (37 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 1.35 KB

Contributing to Spot

First off, thanks for your interest in contributing to Spot — your support helps make local event discovery smarter and more personal.

Getting Started

  1. Fork the repository and clone it to your machine.
  2. Make sure you’re using Node.js v18+ and pnpm.
  3. Run pnpm install to install dependencies.
  4. Start the dev server with pnpm dev.

Code Style

  • Spot uses Next.js 15 (App Router) with TypeScript and Tailwind CSS.
  • Follow established patterns in app/, components/, and lib/.
  • Run pnpm lint and pnpm format before submitting any changes.

Branch Naming

Use descriptive branch names:

feature/event-filter
fix/api-timeout
refactor/card-component

Making Changes

  • Open a new issue or join an existing discussion before starting major work.
  • Create a pull request targeting the main branch.
  • Add clear descriptions and screenshots (if applicable).

Commit Messages

Follow the conventional format:

feat: add personalized event feed
fix: correct timezone offset in API call

What You Can Help With

  • UI/UX improvements
  • Integrating new event APIs
  • Optimizing performance
  • Writing tests
  • Improving accessibility
  • Localizing UI text

Thanks for helping build Spot! Let's help more people find, explore, and enjoy events around them.