- Target feature additions or bug fixes.
- Avoid mixing in formatting or style changes—submit those separately.
- Match the project’s style (Next.js, TypeScript, Tailwind CSS).
- Run
bun run lint
to enforce ESLint rules before submitting.
- Use imperative mood (e.g., "Add feature" not "Added feature").
- Link to issues if applicable (e.g., "Fixes #123").
- Provide a concise title and thorough description.
- Add screenshots for UI changes and testing steps for reviewers.
- Address one issue or feature per PR.
- Split large changes into smaller, logical commits.
- Rebase on the latest
main
branch before submitting. - Resolve conflicts and test thoroughly.
- Check your code for errors or improvements.
- Test changes with
bun dev
to ensure they work.
git checkout -b feat/my-change
- Make changes and run
bun run lint
- Commit:
git commit -m "Add my change"
- Rebase:
git pull --rebase origin main
- Push:
git push origin feat/my-change
- Submit a PR with a clear title, description, and testing instructions.
- Dependencies: Only add new ones if justified, ensuring compatibility with Next.js 15.2.3, React 19, and TypeScript 5.
- Tools: Leverage ESLint, TypeScript, and Tailwind CSS as configured in
package.json
.