Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (30 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

44 lines (30 loc) · 1.2 KB
Raw

Contributing

StudyStack AI is focused on a polished, student-facing study experience. Contributions should preserve existing flows and keep the UI clear for normal users.

Local Setup

  1. Install dependencies:
npm install
  1. Copy the environment example:
cp .env.example .env.local
  1. Add Supabase and OpenAI values, then run:
npm run dev

Development Guidelines

  • Keep changes small and readable.
  • Preserve auth, uploads, documents, threaded chat, planner entries, flashcards, quizzes, manual study tools, richer study sessions, and secure preview/download flows.
  • Keep Supabase user scoping and RLS assumptions intact.
  • Keep OpenAI usage server-side.
  • Avoid exposing internal implementation details in user-facing UI.
  • Prefer student-friendly wording over developer or infrastructure language.
  • Run npm run lint and npm run build before opening a PR when possible.

Pull Requests

Pull request descriptions should include:

  • What changed
  • How it was tested
  • Any setup or migration notes
  • Screenshots for UI changes, if available

Issues, commits, screenshots, and PR descriptions must not include real API keys, database credentials, or private user data.