Markdown Converter
Agent skill for markdown-converter
This document contains common guidelines for AI assistants working on the validate-pr-review-app project.
Sign in to like and favorite skills
This document contains common guidelines for AI assistants working on the validate-pr-review-app project. Individual AI-specific documents (like CLAUDE.md, CLINE.md) should reference this guide.
This project uses English for all code comments, documentation, and communication.
Follow Conventional Commits specification:
<type>[optional scope]: <description> [optional body] [optional footer(s)]
feat: A new featurefix: A bug fixdocs: Documentation only changesstyle: Changes that do not affect the meaning of the coderefactor: A code change that neither fixes a bug nor adds a featuretest: Adding missing tests or correcting existing testschore: Changes to the build process or auxiliary toolsci: Changes to CI configuration files and scriptsfeat: add GitHub token management via keyring fix: handle empty configuration file correctly docs: add function documentation to controller package chore(deps): update dependency aquaproj/aqua-registry to v4.403.0
After making code changes, always run the following commands to validate and test:
cmdx v
This command runs
go vet ./... to check for common Go mistakes.
cmdx t
This command runs all tests in the project.
Both commands should pass before committing changes.
undefined
Command-line interface layer that handles command parsing, flag processing, and routing to appropriate subcommands.
Configuration management including:
HTTP request handling and webhook processing:
Core business logic for PR review validation:
GitHub API integration layer:
testify for writing testsgoogle/go-cmp for comparing expected and actual valuestesting) for all testscmdx t or go test -race -covermode=atomic ./...go test -race -covermode=atomic ./pkg/validation./scripts/coverage.shThis project uses:
maincmdx v and cmdx t pass# Validate code (go vet) cmdx v # Run tests cmdx t
The project includes GitHub Actions for:
parse_line.go)_test.go to the source file name_internal_test.go for internal testingfmt.Errorf with %w for wrapping errors