Contribution Guide

Contribution Guide

Recommended Workflow

1. Fork the repository
2. Create a feature branch
3. Implement your change
4. Test locally
5. Open a Pull Request

Contribution Setup

git clone https://github.com/<your-user>/FoodSaver-AI.git
cd FoodSaver-AI
npm install
npm run dev

Branch Naming

• feature/<short-name>
• fix/<short-name>
• docs/<short-name>

Examples:

• feature/openai-recipe-api
• fix/date-expiry-calculation

Minimum QA Checklist Before PR

• app starts without errors
• navigation Pantry -> Recipes -> Impact works
• add/delete/consume item flow is verified
• recipe generation is verified
• localStorage persistence works after refresh

Coding Guidelines

• keep components focused and simple
• avoid duplicate date logic
• use explicit state names
• explain non-obvious decisions in the PR description

Commit Message Format

type(scope): short summary

Examples:

• feat(recipes): add real api integration placeholder
• fix(pantry): handle expired item state
• docs(wiki): rewrite pages in English