Uui PR Contributing

UUI Pull Request Process

Follow this checklist when preparing a pull request for UUI.

Pre-PR Checklist

Before opening a PR, ensure all items are complete:

• All tests pass - Run yarn test
• Snapshots updated - If UI changed, run yarn test-update
• E2E tests pass - If UI changed, run yarn test-e2e
• ESLint passes - Run yarn eslint (or yarn eslint-fix)
• Stylelint passes - Run yarn stylelint (or yarn stylelint-fix)

Note: Husky runs lint-staged on commit, which auto-fixes ESLint and Stylelint for staged files. You can still run lint manually to catch issues before committing.

• Bundle size check passes - Run yarn track-bundle-size
• TypeScript type checking passes - Run yarn test-typecheck
• Documentation updated - If API changed, add examples and update Property Explorer
• Changelog updated - Add entry to changelog.md

Git Workflow

Branch Creation

1. Fork and clone the repository
2. Create branch from develop (not main):

   git checkout develop
   git pull origin develop
   git checkout -b fix/123-description

Branch Naming

Use descriptive branch names following these patterns:

For bug fixes:

• fix/123-dropdown-position - Include GitHub issue number
• fix/dropdown-position - If no issue number

For features:

• feature/456-new-component - Include GitHub issue number
• feature/new-component - If no issue number

For other changes:

• refactor/component-structure
• docs/update-readme

Important: When working on features or bugs from GitHub issues, include the issue number in the branch name (e.g., fix/123-description, feature/456-new-component).

Avoid generic names:

• ❌ update
• ❌ fix
• ❌ changes

Commit Messages

• Use clear, descriptive commit messages
• Reference issue numbers when applicable: fix: resolve dropdown positioning issue (#123)
• Follow conventional commit format when possible:
  • feat: add new component
  • fix: correct date formatting
  • docs: update README
  • refactor: simplify component logic
• Before committing: Always show the proposed commit message to the user and wait for approval before running git commit. Do not commit automatically.
• Shell compatibility: Do not use bash-only syntax (heredoc <<'EOF', && chaining). Use multiple -m flags for multi-line commits:

  git commit -m "subject line" -m "body line 1" -m "body line 2"

PR Requirements

Code Quality

• All tests must pass (yarn test)
• Bundle size check must pass (yarn track-bundle-size)
• E2E tests must pass (if UI changes)
• Code must be linted (yarn eslint, yarn stylelint)

Documentation

If making API changes or adding functionality:

1. Add example to documentation:

   • Location: app/src/docs/_examples
   • Add link in page config: app/src/docs/pages

2. Update Property Explorer:

   • Location: app/src/docs/explorerConfigs
   • Add/update explorer config for component

3. Add JSDoc on every new/changed exported type and non-inherited public prop. The quality gate fails if the amount of props without comments increases (see documentation).

4. Generate API:

   yarn generate-components-api

Changelog

Add entry to the top (unreleased) section of changelog.md:

# 6.x.x - xx.xx.2026

**What's New**
* [ComponentName]: description of new feature ([#456](https://github.com/epam/UUI/issues/456))

**What's Fixed**
* [ComponentName]: description of fix ([#123](https://github.com/epam/UUI/issues/123))

Format:

• Use **What's New** for features/enhancements, **What's Fixed** for bug fixes
• Prefix with [ComponentName]: to identify the affected component
• Include issue link in markdown format: ([#123](https://github.com/epam/UUI/issues/123))
• Add to the existing top section; do not create a new version header