-
Notifications
You must be signed in to change notification settings - Fork 1
feat(rules): add code quality cursor rules #8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
c640071
feat(rules): add code quality cursor rules
anatolyshipitz 0562aa5
feat(rules): enhance verify-information rule with clarity on assumptions
anatolyshipitz 46579aa
feat(rules): update various rules with descriptions and glob patterns
anatolyshipitz f937582
chore(gitignore): update Cursor rules exclusion pattern
anatolyshipitz 509dd04
ci: enhance code quality workflow with security scanning
anatolyshipitz b588652
ci: update GitHub Actions dependencies
anatolyshipitz 250eb05
Merge branch 'main' into feature/add-cursor-rules
anatolyshipitz 35641a0
Merge branch 'main' into feature/add-cursor-rules
anatolyshipitz 0d91059
Merge branch 'main' into feature/add-cursor-rules
anatolyshipitz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| --- | ||
| description: "Enforces conventional commit message format for better version control and changelog generation" | ||
| globs: ["**/*"] | ||
| --- | ||
|
|
||
| # Conventional Commit Messages | ||
|
|
||
| Use the Conventional Commit Messages specification to generate commit messages. | ||
|
|
||
| ## Commit Message Structure | ||
|
|
||
| ``` | ||
| <type>[optional scope]: <description> | ||
|
|
||
| [optional body] | ||
|
|
||
| [optional footer(s)] | ||
| ``` | ||
|
|
||
| ## Commit Types | ||
|
|
||
| - `fix`: Patches a bug in your codebase (correlates with PATCH in Semantic Versioning) | ||
| - `feat`: Introduces a new feature to the codebase (correlates with MINOR in Semantic Versioning) | ||
| - `BREAKING CHANGE`: Introduces a breaking API change (correlates with MAJOR in Semantic Versioning) | ||
| - Other allowed types: `build:`, `chore:`, `ci:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:` | ||
|
|
||
| ## Specification Details | ||
|
|
||
| 1. Commits MUST be prefixed with a type, followed by an OPTIONAL scope, OPTIONAL !, and REQUIRED terminal colon and space | ||
| 2. The type `feat` MUST be used when adding a new feature | ||
| 3. The type `fix` MUST be used when fixing a bug | ||
| 4. A scope MAY be provided after a type, surrounded by parenthesis (e.g., `fix(parser):`) | ||
| 5. A description MUST immediately follow the colon and space | ||
| 6. A longer commit body MAY be provided after the short description | ||
| 7. One or more footers MAY be provided one blank line after the body | ||
| 8. Breaking changes MUST be indicated in the type/scope prefix or as a footer | ||
| 9. If included as a footer, a breaking change MUST use: `BREAKING CHANGE: description` | ||
| 10. If included in the type/scope prefix, breaking changes MUST use `!` before the `:` | ||
| 11. Types other than `feat` and `fix` MAY be used | ||
| 12. Information MUST NOT be treated as case sensitive, except for `BREAKING CHANGE` | ||
| 13. `BREAKING-CHANGE` MUST be synonymous with `BREAKING CHANGE` | ||
|
|
||
| ## Examples | ||
|
|
||
| ``` | ||
| feat: add new authentication system | ||
|
|
||
| This commit adds a new authentication system using JWT tokens. | ||
| The system supports both local and OAuth authentication methods. | ||
|
|
||
| BREAKING CHANGE: Authentication endpoints have been moved to /api/v2/auth | ||
| ``` | ||
|
|
||
| ``` | ||
| fix(parser): handle empty input gracefully | ||
|
|
||
| Previously, the parser would throw an error when given empty input. | ||
| This commit adds proper handling for empty input cases. | ||
| ``` | ||
|
|
||
| ``` | ||
| chore: update dependencies | ||
|
|
||
| - Update React to v18.2.0 | ||
| - Update TypeScript to v4.9.5 | ||
| - Update Jest to v29.5.0 | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| --- | ||
| description: "Provides guidelines for Docker service configuration and setup" | ||
| globs: ["docker-compose.yml", "Dockerfile*", "volumes/**/*"] | ||
| --- | ||
|
|
||
| # Docker Configuration Guide | ||
|
|
||
| ## Service Configuration | ||
| The [docker-compose.yml](mdc:docker-compose.yml) file defines all service configurations and their relationships. Key aspects include: | ||
| - Service dependencies | ||
| - Volume mounts | ||
| - Network configuration | ||
| - Environment variables | ||
| - Port mappings | ||
|
|
||
| ## Custom Images | ||
| Two custom Docker images are used: | ||
| 1. [Dockerfile.n8n](mdc:Dockerfile.n8n) - Extends official n8n image with custom configurations | ||
| 2. [Dockerfile.temporal](mdc:Dockerfile.temporal) - Extends official Temporal auto-setup image | ||
|
|
||
| ## Data Persistence | ||
| All service data is persisted in Docker volumes mapped to the local `volumes/` directory: | ||
| - n8n data: `./volumes/n8n_data` | ||
| - OpenSearch: `./volumes/opensearch-data` | ||
| - PostgreSQL: `./volumes/postgresql-data` | ||
|
|
||
| ## Network Configuration | ||
| Services communicate over an internal Docker network with the following exposed ports: | ||
| - n8n: 5678 (HTTP) | ||
| - Temporal: 7233 (gRPC) | ||
| - Temporal UI: 8080 (HTTP) | ||
| - PostgreSQL: 5432 | ||
| - OpenSearch: 9200 (HTTP) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| description: "Prohibits the use of apologies in communication" | ||
| globs: ["**/*"] | ||
| --- | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| - Never use apologies | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| description: "Prohibits summarizing changes made in communication" | ||
| globs: ["**/*"] | ||
| --- | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| - Don't summarize changes made | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| description: "Prohibits asking for confirmation of information already provided in context" | ||
| globs: ["**/*"] | ||
| --- | ||
|
|
||
| - Don't ask for confirmation of information already provided in the context |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| description: "Prohibits suggesting updates or changes when no modifications are needed" | ||
| globs: ["**/*"] | ||
| --- | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| - Don't suggest updates or changes to files when there are no actual modifications needed | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| description: "Ensures preservation of existing code and functionality during modifications" | ||
| globs: ["**/*"] | ||
| --- | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
|
|
||
| - Don't remove unrelated code or functionalities. Pay attention to preserving existing structures. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| --- | ||
| description: "Documents the project structure and service architecture" | ||
| globs: ["**/*"] | ||
| --- | ||
|
|
||
| # Project Structure Guide | ||
|
|
||
| This repository contains a Docker Compose setup for running n8n (workflow automation tool) and Temporal (workflow orchestration platform) services together. | ||
|
|
||
| ## Key Files | ||
| - [docker-compose.yml](mdc:docker-compose.yml) - Main service orchestration configuration | ||
| - [Dockerfile.n8n](mdc:Dockerfile.n8n) - Custom n8n image configuration | ||
| - [Dockerfile.temporal](mdc:Dockerfile.temporal) - Custom Temporal image configuration | ||
|
|
||
| ## Important Directories | ||
| - `volumes/` - Contains persistent data for all services: | ||
| - `n8n_data/` - n8n workflows and data | ||
| - `opensearch-data/` - OpenSearch data for Temporal | ||
| - `postgresql-data/` - PostgreSQL database for Temporal | ||
| - `scripts/` - Contains utility scripts for setup and maintenance | ||
|
|
||
| ## Service Architecture | ||
| The project consists of several interconnected services: | ||
| 1. n8n (Port 5678) - Workflow automation tool | ||
| 2. Temporal Server (Port 7233) - Workflow orchestration engine | ||
| 3. Temporal UI (Port 8080) - Web interface for Temporal | ||
| 4. PostgreSQL (Port 5432) - Database for Temporal | ||
| 5. OpenSearch (Port 9200) - Search engine for Temporal visibility features |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| description: "Provides service setup, health verification, and troubleshooting guidelines" | ||
| globs: ["scripts/*.sh", "docker-compose.yml", ".env*"] | ||
| --- | ||
|
|
||
| # Service Configuration Guide | ||
|
|
||
| ## Setup Instructions | ||
| 1. Run [scripts/setup_volumes.sh](mdc:scripts/setup_volumes.sh) to create required volume directories | ||
| 2. Create `.env` file from `.env.example` for environment configuration | ||
| 3. Use `docker compose up -d` to start all services | ||
|
|
||
| ## Service Health Verification | ||
| The [scripts/check_services.sh](mdc:scripts/check_services.sh) script verifies accessibility of: | ||
| - n8n health endpoint (http://localhost:5678/healthz) | ||
| - Temporal UI (http://localhost:8080) | ||
| - OpenSearch API (http://localhost:9200) | ||
| - Temporal server gRPC (localhost:7233) | ||
| - PostgreSQL database (localhost:5432) | ||
|
|
||
| ## Service Access | ||
| - n8n UI: http://localhost:5678 | ||
| - Temporal UI: http://localhost:8080 | ||
| - OpenSearch API: http://localhost:9200 | ||
|
|
||
| ## Troubleshooting | ||
| 1. Check container logs using `docker logs` | ||
| 2. Verify port availability | ||
| 3. Ensure sufficient Docker resources | ||
| 4. Run setup script for volume mount issues | ||
| 5. Check service health endpoints |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| description: "Requires providing all edits in a single chunk instead of multiple steps" | ||
| globs: ["**/*"] | ||
| --- | ||
|
|
||
| - Provide all edits in a single chunk instead of multiple-step instructions or explanations for the same file |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| description: "Requires verification of information before presentation" | ||
| globs: ["**/*"] | ||
| --- | ||
|
|
||
| - Always verify information before presenting it. Do not make assumptions or speculate without clear evidence. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.