Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (47 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

61 lines (47 loc) · 1.55 KB
Raw

Contributing to Stash

Thank you for your interest in improving Stash! We welcome bug fixes, performance optimizations, accessibility improvements, and documentation updates.

1. Development Setup

  1. Clone the repository:

    git clone https://github.com/zakiuhh/stash.git
cd stash

  2. Install dependencies:

    bun install --force
# or: npm install --force

  3. Start the local Next.js dev server:

    bun run dev
# or: npm run dev

  4. Verify TypeScript type safety:

    bunx tsc --noEmit

2. Commit Message Guidelines

We follow the Conventional Commits specification. Please keep commit messages concise, lowercase, and descriptive:

  • feat: add new feature (e.g. feat(mobile): add haptic vibration on card drop)
  • fix: resolve bug (e.g. fix(routing): resolve folder param query error)
  • docs: update documentation (e.g. docs: add android studio setup instructions)
  • refactor: code refactoring (e.g. refactor: optimize zustand memoized selectors)
  • perf: performance enhancement (e.g. perf: memoize spatial canvas item nodes)

3. Pull Request Process

  1. Create a descriptive feature branch: 
    git checkout -b feat/your-feature-name
  2. Make sure your changes pass TypeScript checks: 
    bunx tsc --noEmit
  3. Test that the production build compiles cleanly: 
    bun run build
  4. Commit your changes with a conventional commit message.
  5. Push to your fork and submit a Pull Request to main.