Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (69 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

84 lines (69 loc) · 2.04 KB

Contributing to closedNote

Thanks for taking the time to contribute! closedNote is an open source project and contributions of all kinds are welcome.

Getting Started

  1. Fork the repo
  2. Clone your fork:
   git clone https://github.com/your-username/closedNote.git
   cd closedNote
  1. Install dependencies:
   npm install
  1. Copy the environment file and fill in your Supabase keys:
   cp .env.example .env.local
  1. Run the development server:
   npm run dev

How to Contribute

Reporting Bugs

  • Check the open issues first to avoid duplicates
  • Open a new issue with a clear title, steps to reproduce, and expected vs actual behavior

Suggesting Features

  • Open an issue with the enhancement label
  • Explain the problem you're trying to solve, not just the solution

Submitting Code

  1. Create a new branch from main:
   git checkout -b feature/your-feature-name
  1. Make your changes
  2. Run tests and make sure they pass:
   npm test
  1. Run the linter:
   npm run lint
  1. Commit with a clear message:
   git commit -m "feat: add your feature description"
  1. Push and open a pull request against main

Commit Message Convention

Use conventional commits where possible:

  • feat: — new feature
  • fix: — bug fix
  • docs: — documentation changes
  • refactor: — code change that neither fixes a bug nor adds a feature
  • test: — adding or updating tests
  • chore: — maintenance tasks

Project Structure

app/          # Next.js App Router pages and API routes
components/   # React components
lib/          # Utility functions and shared logic
supabase/     # Database migrations
__tests__/    # Test files

Code Style

  • TypeScript is required — avoid any types where possible
  • Follow the existing ESLint configuration (npm run lint)
  • Keep components small and focused

Questions?

Open an issue or reach out via LinkedIn.