Introduce AI assistant rules and commands #5222

valkirilov · 2025-11-21T08:20:54Z

What

Add comprehensive AI rules for code quality, frontend, backend, testing, and workflows.
Include commands for commit messages, PR planning/review, and UI testing.

Add .ai/ directory with rules and command documentation, serving as a single source of truth
Add Cursor, Augument, and GitHub Copilot integration files, pointing to the .ai/ rules and commands
Add MCP configuration for communication with external services (like Jira, Confluence, GitHub)

Final Structure

.ai/                                  # 🎯 Single source of truth
├── README.md                         # Overview & quick reference
├── rules/                            # Development standards (modular)
│   ├── 01-CODE_QUALITY.md            # Linting, formatting, TypeScript
│   ├── 02-FRONTEND.md                # React, Redux, UI patterns
│   ├── 03-BACKEND.md                 # NestJS, API patterns
│   ├── 04-TESTING.md                 # Testing standards
│   └── 05-WORKFLOW.md                # Git, commits, dev workflow
└── commands/                         # AI workflow commands
    └── pr/
        ├── review.md                 # PR review workflow
        └── plan.md                   # PR planning workflow

# Symlinks (all AI tools read from .ai/)
.cursor/
  ├── rules/ -> ../.ai/rules/         # Cursor AI (rules)
  └── commands/ -> ../.ai/commands/   # Cursor AI (commands)
.augment/ -> .ai/                     # Augment AI
.windsurfrules -> .ai/                # Windsurf AI
.github/copilot-instructions.md -> ../.ai/ # GitHub Copilot

Add comprehensive AI rules for code quality, frontend, backend, testing, and workflows. Include commands for commit messages, PR planning/review, and UI testing. - Add .ai/ directory with rules and command documentation - Add .cursor/ and .augument/ integration files - Add GitHub Copilot instructions - Add MCP configuration and example environment file - Update .gitignore for AI-related files

pd-redis · 2025-11-21T09:25:44Z

mcp.json

+  "$schema": "https://modelcontextprotocol.io/schema/mcp.json",
+  "mcpServers": {
+    "git": {
+      "command": "uvx",


UVX is not available on my system. Maybe some info about how to set it up is also needed

I'll check it, we might not need this at all (see this)

pd-redis · 2025-11-21T09:26:25Z

mcp.json

+      "args": ["mcp-server-git"],
+      "description": "Git operations for the RedisInsight repository including status, diff, log, and branch management"
+    },
+    "github": {


Does this work without token?

This MCP config is based on the one used by LangCache.

so far, I have tested the Attlassian MCP, and it works fine with Jira and Confluence when a token is provided (see env.mcp.example)

for the rest of the MCPs, I still need to verify them, and also check whether we need them all

pd-redis · 2025-11-21T09:27:40Z

.ai/README.md

+4. **Verify your setup:**
+   ```bash
+   # For Augment users:
+   auggie --mcp-config mcp.json "go over all my mcp tools and make sure they work as expected"


is this a tool we need to have installed?

The current MCP config is based on the one used by LangCache, that's why this example was inherited.

Still, I don't like the idea of forcing you to install a particular tool, so I have replaced the command.
Still, you'll need an Augment account to utilize this feature.

npx @augmentcode/auggie --mcp-config mcp.json "go over all my mcp tools and make sure they work as expected"

Additionally, added instructions to verify the MCP server's availability in other tools as well (Cursor and Copilot).

pd-redis · 2025-11-21T09:28:53Z

.ai/README.md

+yarn prettier:fix        # Fix formatting
+```
+
+### Before Every Commit


Maybe add "on the changed files" to avoid running on the entire codebase

pd-redis · 2025-11-21T09:30:24Z

.ai/README.md

+
+## Redis-Specific Context
+
+- Support all Redis data types: String, Hash, List, Set, Sorted Set, Stream, JSON


missing vector sets 😁

Not anymore! 😀

pd-redis · 2025-11-21T09:30:53Z

.ai/README.md

+
+### DON'T:
+
+- ❌ Use `console.log` (use proper logging)


What is proper logging?

Correct, we don't have any internal way for logging errors, so I have removed the "(use proper logging)" part. Thanks.

Still, all these guidelines were automatically generated based on the LangCache ruleset and our codebase, so everything can be adjusted or removed in the next few iterations.

pd-redis · 2025-11-21T09:32:33Z

.ai/commands/pr/plan.md

+
+### 1. Ticket Validation
+
+Verify ticket quality:


So basically no jira ticket (that I have seen here) meets these?

pd-redis · 2025-11-21T09:34:25Z

.ai/commands/pr/plan.md

+```
+````
+
+### API Endpoints


This section seems oddly specific to features only, should it be here?

pd-redis · 2025-11-21T09:39:28Z

.ai/commands/run-ui-tests.md

Actually, this is not part of the repo. I would add it, but I am afraid it won't be met friendly :)

I can remove this command if you don't feel like sharing it publicly yet?

valkirilov self-assigned this Nov 21, 2025

valkirilov force-pushed the docs/introduce-ai-rules branch from 25d6b10 to 6abfbb7 Compare November 21, 2025 08:55

valkirilov force-pushed the docs/introduce-ai-rules branch from 6abfbb7 to 0261f2c Compare November 21, 2025 09:10

pd-redis reviewed Nov 21, 2025

View reviewed changes

docs: update reules

d006e93

valkirilov force-pushed the docs/introduce-ai-rules branch from 4fa20eb to d006e93 Compare November 21, 2025 10:58


		## Redis-Specific Context

		- Support all Redis data types: String, Hash, List, Set, Sorted Set, Stream, JSON

Introduce AI assistant rules and commands #5222

Are you sure you want to change the base?

Introduce AI assistant rules and commands #5222

Uh oh!

Conversation

valkirilov commented Nov 21, 2025

What

Final Structure

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants