Skip to content
This repository was archived by the owner on Mar 7, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 128 additions & 0 deletions .github/CODEOWNERS.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# CODEOWNERS.example
#
# This is a template for the CODEOWNERS file that defines code ownership for the UI Kit repository.
# To activate this file, rename it to "CODEOWNERS" and create the GitHub teams referenced below.
#
# Code owners are automatically requested for review when someone opens a pull request that modifies code that they own.
#
# More info: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
#
# NOTE: The GitHub teams referenced in this file (@ui-kit-maintainers, @devops-team, etc.)
# need to be created in the GitHub organization before this file can be activated.

# Global Owners
# These users are the default owners for everything in the repo unless a later match takes precedence.
* @ui-kit-maintainers

# Root Configuration Files
# Critical configuration files that affect the entire project
/.github/ @ui-kit-maintainers @devops-team
/package.json @ui-kit-maintainers
/pnpm-lock.yaml @ui-kit-maintainers
/pnpm-workspace.yaml @ui-kit-maintainers
/tsconfig*.json @ui-kit-maintainers
/vite.config.ts @ui-kit-maintainers
/.eslintrc.cjs @ui-kit-maintainers
/.prettierrc @ui-kit-maintainers
/tailwind.config.js @ui-kit-maintainers

# DevContainer and Docker
/.devcontainer/ @devops-team
/Dockerfile* @devops-team
/docker-compose*.yml @devops-team

# CI/CD and Automation
/.github/workflows/ @devops-team @ui-kit-maintainers
/.github/actions/ @devops-team
/.changeset/ @ui-kit-maintainers
/scripts/ @devops-team @ui-kit-maintainers

# Documentation
/README.md @docs-team @ui-kit-maintainers
/CONTRIBUTING.md @docs-team @ui-kit-maintainers
/CHANGELOG.md @docs-team @ui-kit-maintainers
/docs/ @docs-team
/.github/pull_request_template.md @docs-team @ui-kit-maintainers
/.github/CODEOWNERS @ui-kit-maintainers

# UI Kit Package
/packages/ui-kit/ @ui-kit-maintainers

# Core Components
/packages/ui-kit/src/components/primitives/ @component-team @ui-kit-maintainers
/packages/ui-kit/src/components/layout/ @layout-team @ui-kit-maintainers
/packages/ui-kit/src/components/form/ @form-team @ui-kit-maintainers

# Providers and Context
/packages/ui-kit/src/providers/ @architecture-team @ui-kit-maintainers

# Utilities and Hooks
/packages/ui-kit/src/utils/ @utils-team @ui-kit-maintainers
/packages/ui-kit/src/hooks/ @hooks-team @ui-kit-maintainers

# Styling and Theming
/packages/ui-kit/src/styles/ @design-system-team @ui-kit-maintainers
/packages/ui-kit/src/theme/ @design-system-team @ui-kit-maintainers
/packages/ui-kit/src/tokens/ @design-system-team @ui-kit-maintainers

# Testing Infrastructure
/packages/ui-kit/src/**/*.test.* @testing-team @ui-kit-maintainers
/packages/ui-kit/src/**/*.spec.* @testing-team @ui-kit-maintainers
/packages/ui-kit/cypress/ @testing-team @ui-kit-maintainers
/packages/ui-kit/playwright/ @testing-team @ui-kit-maintainers
/packages/ui-kit/vitest.config.ts @testing-team @ui-kit-maintainers
/packages/ui-kit/cypress.config.ts @testing-team @ui-kit-maintainers
/packages/ui-kit/playwright.config.ts @testing-team @ui-kit-maintainers

# Storybook
/packages/ui-kit/.storybook/ @storybook-team @ui-kit-maintainers
/packages/ui-kit/src/**/*.stories.* @storybook-team @component-team

# Build and Bundle Configuration
/packages/ui-kit/vite.config.ts @build-team @ui-kit-maintainers
/packages/ui-kit/tsconfig*.json @build-team @ui-kit-maintainers
/packages/ui-kit/package.json @ui-kit-maintainers

# Security and Dependencies
/packages/ui-kit/pnpm-lock.yaml @security-team @ui-kit-maintainers
/.nvmrc @devops-team
/.node-version @devops-team

# Specific Component Ownership Examples
# Uncomment and modify these as teams are assigned to specific components

# /packages/ui-kit/src/components/primitives/Button/ @button-specialist
# /packages/ui-kit/src/components/primitives/Input/ @form-specialist
# /packages/ui-kit/src/components/layout/Grid/ @layout-specialist
# /packages/ui-kit/src/components/form/DataTable/ @datatable-specialist

# Performance and Bundle Size
/packages/ui-kit/size-limit.config.js @performance-team @ui-kit-maintainers

# Error Handling and Monitoring
/packages/ui-kit/src/providers/ErrorBoundary/ @monitoring-team @ui-kit-maintainers
/packages/ui-kit/src/utils/logger/ @monitoring-team @ui-kit-maintainers

# Accessibility
/packages/ui-kit/src/**/*a11y* @accessibility-team @ui-kit-maintainers
/packages/ui-kit/src/**/*accessibility* @accessibility-team @ui-kit-maintainers

# Team Definitions (GitHub teams that should be created)
#
# @ui-kit-maintainers - Core maintainers with full repository access
# @devops-team - DevOps and infrastructure specialists
# @docs-team - Documentation specialists
# @component-team - UI component specialists
# @layout-team - Layout and responsive design specialists
# @form-team - Form component specialists
# @architecture-team - System architecture specialists
# @utils-team - Utility function specialists
# @hooks-team - React hooks specialists
# @design-system-team - Design system and theming specialists
# @testing-team - Testing infrastructure specialists
# @storybook-team - Storybook and documentation specialists
# @build-team - Build and bundling specialists
# @security-team - Security and dependency management specialists
# @performance-team - Performance and optimization specialists
# @monitoring-team - Error handling and monitoring specialists
# @accessibility-team - Accessibility specialists
258 changes: 258 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,258 @@
## Description

### Summary

<!-- Provide a brief summary of the changes in this PR -->

### Motivation and Context

<!-- Why is this change required? What problem does it solve? -->
<!-- If it fixes an open issue, please link to the issue here -->

### Type of Change

<!-- Mark the relevant option with an "x" -->

- [ ] πŸ› 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

<!-- List the main components, features, or areas of code that were changed -->

-
-
-

### Files Changed

<!-- List the key files that were modified (auto-generated by GitHub, but highlight important ones) -->

-
-
-

## Testing

### Test Coverage

<!-- Describe the tests you ran to verify your changes -->

- [ ] Unit tests added/updated
- [ ] Integration tests added/updated
- [ ] Storybook stories added/updated
- [ ] Accessibility tests pass
- [ ] Visual regression tests pass
- [ ] Manual testing completed

### Test Instructions

<!-- Provide instructions for reviewers to test your changes -->

1.
2.
3.

### Screenshots/Videos

<!-- If applicable, add screenshots or videos to help explain your changes -->

## Bundle Size Impact

### Size Analysis

<!-- Run `pnpm build && pnpm size-limit` and report results -->

- [ ] 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

<!-- List any breaking changes to the public API -->

- [ ] No breaking changes
- [ ] Breaking changes documented below

### Migration Guide

<!-- If there are breaking changes, provide a migration guide -->

### Deprecation Notices

<!-- List any deprecated features or APIs -->

## 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

<!-- Report any accessibility 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

<!-- Describe how to rollback these changes if needed -->

## Related Issues

### Closes

<!-- List any issues this PR closes -->

- Closes #
- Fixes #
- Resolves #

### Related

<!-- List any related issues or PRs -->

- Related to #
- Depends on #
- Blocks #

## Reviewer Notes

### Focus Areas

<!-- Highlight specific areas where you want reviewer attention -->

-
-
-

### Questions for Reviewers

<!-- Any specific questions or concerns for reviewers -->

-
-
-

### Additional Context

<!-- Any additional context that would be helpful for reviewers -->

---

## 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.
Loading