commits

by redis

Follow Conventional Commits format:

npx skills add https://github.com/redis/redisinsight --skill commits
Download ZIPGitHub
8.7k

Commit Message Guidelines

Follow Conventional Commits format:

<type>(<scope>): <subject>

<body>

<footer>

Commit Types

  • feat - New feature
  • fix - Bug fix
  • refactor - Code refactoring
  • test - Adding or updating tests
  • docs - Documentation changes
  • chore - Maintenance tasks
  • style - Code style changes (formatting)
  • perf - Performance improvements
  • ci - CI/CD changes

Examples

feat(ui): add user search functionality

Implements real-time search with debouncing.

References: #RI-123

---

fix(api): resolve memory leak in connection pool

Properly cleanup subscriptions on unmount.

Fixes #456

---

test(ui): add tests for data serialization

refactor(api): extract common validation logic

docs: update API endpoint documentation

chore: upgrade React to version 18.2

Best Practices

✅ Good Commits

  • Clear, descriptive subject line
  • Atomic changes (one logical change per commit)
  • Reference issue/ticket in body
  • Explain why, not just what
  • Keep it concise - Don't list every file change in the body
feat(ui): add user profile editing

Allows users to update their profile information including
name, email, and avatar. Includes validation and error handling.

References: #RI-123

❌ Bad Commits

# Too vague
fix stuff
WIP
update

# Too broad
add feature, fix bugs, refactor code, update tests

Issue References

  • JIRA (internal): References: #RI-123 or Fixes #RI-123
  • GitHub (open source): Fixes #456 or Closes #456
  • Use # for auto-linking in commit messages

More skills from redis

docs-sync
redis
Analyze master branch implementation and configuration to find missing, incorrect, or outdated documentation in docs/, README.md, and per-package READMEs. Use…
official
implement-command
redis
Add a new Redis command (or command variant) to node-redis end-to-end — the `<NAME>.ts` Command file, its registration with JSDoc in the package…
official
maintainer-review
redis
Review a GitHub issue or pull request URL as a node-redis maintainer, with a staged assessment of whether the claim is real, practically important, already…
official
pr-draft-summary
redis
Create the required PR-ready summary block, branch suggestion, title, and draft description for node-redis. Must be used before the final response whenever the…
official
runtime-behavior-probe
redis
Plan and execute runtime-behavior investigations with temporary TypeScript probe scripts, validation matrices, state controls, and findings-first reports. Use…
official
backend
redis
NestJS backend development patterns for the RedisInsight API: module structure, services, controllers, DTOs, dependency injection, and error handling. Use when…
official
branches
redis
Use lowercase kebab-case with type prefix and issue/ticket identifier. Branch names must match GitHub Actions workflow rules (see .github/workflows/enforce-branch-name-rules.yml ).
official
code-quality
redis
Code-quality standards for RedisInsight: TypeScript strictness, naming conventions (camelCase, PascalCase, UPPER_SNAKE_CASE), linting rules, no `any` without…
official