Skip to content
This repository was archived by the owner on Mar 7, 2026. It is now read-only.

Latest commit

 

History

History
258 lines (166 loc) · 5.62 KB

File metadata and controls

258 lines (166 loc) · 5.62 KB

Description

Summary

Motivation and Context

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📚 Documentation update
  • 🔧 Refactoring (no functional changes, no api changes)
  • 🎨 Style changes (formatting, missing semi colons, etc; no code changes)
  • 🧪 Test changes (adding missing tests, refactoring tests; no production code changes)
  • 🔨 Build/CI changes (changes to build process or CI configuration)

Changes Made

Components/Features Added or Modified

Files Changed

Testing

Test Coverage

  • Unit tests added/updated
  • Integration tests added/updated
  • Storybook stories added/updated
  • Accessibility tests pass
  • Visual regression tests pass
  • Manual testing completed

Test Instructions

Screenshots/Videos

Bundle Size Impact

Size Analysis

  • Bundle size increase is within acceptable limits (< 10KB gzipped)
  • No bundle size increase
  • Bundle size decreased

Size Report

<!-- Paste the output of `pnpm size-limit` here -->

Breaking Changes

API Changes

  • No breaking changes
  • Breaking changes documented below

Migration Guide

Deprecation Notices

Documentation

Documentation Updates

  • README updated (if needed)
  • CONTRIBUTING.md updated (if needed)
  • Storybook documentation updated
  • TypeScript types documented
  • Changelog entry added (via changeset)

Storybook

  • New stories added for new components
  • Existing stories updated for modified components
  • All stories render without errors
  • Interactive examples work correctly

Accessibility

A11y Compliance

  • Components are keyboard navigable
  • Proper ARIA labels and roles added
  • Color contrast meets WCAG standards
  • Screen reader testing completed
  • axe-core tests pass

A11y Testing Results

Code Quality

Code Review Checklist

  • Code follows project style guidelines
  • Self-review of code completed
  • Code is well-commented, particularly in hard-to-understand areas
  • No console.log statements left in production code
  • No TODO comments without associated issues
  • TypeScript types are properly defined
  • Error handling is appropriate

Linting and Formatting

  • ESLint passes without errors
  • Prettier formatting applied
  • TypeScript compilation successful
  • No new TypeScript errors introduced

Dependencies

Dependency Changes

  • No new dependencies added
  • New dependencies justified and documented
  • Dependencies updated to latest secure versions
  • No unused dependencies

Security

  • No security vulnerabilities introduced
  • Sensitive data properly handled
  • Input validation implemented where needed

Deployment

Environment Impact

  • Changes work in development environment
  • Changes work in production-like environment
  • No environment-specific configurations needed

Rollback Plan

Related Issues

Closes

  • Closes #
  • Fixes #
  • Resolves #

Related

  • Related to #
  • Depends on #
  • Blocks #

Reviewer Notes

Focus Areas

Questions for Reviewers

Additional Context


Reviewer Checklist

Code Review

  • Code is readable and well-structured
  • Logic is sound and efficient
  • Error handling is appropriate
  • Security considerations addressed
  • Performance impact considered

Testing Review

  • Test coverage is adequate
  • Tests are meaningful and test the right things
  • Edge cases are covered
  • Tests pass consistently

Documentation Review

  • Documentation is accurate and complete
  • Examples are clear and helpful
  • API documentation is up to date

Design Review

  • UI/UX follows design system guidelines
  • Responsive design works correctly
  • Accessibility requirements met
  • Visual design is consistent

Final Approval

  • All automated checks pass
  • Manual testing completed
  • Ready for merge

Note for Reviewers: Please ensure all checklist items are completed before approving. If any items are not applicable, mark them as complete and note why in your review comments.