OpenParable
Skip to content
← Back to skills

Plugin Workflow

Development
plugin-workflow

Plugin Workflow is an Agent Skill for development published in the erxes/erxes repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Baseline workflow for erxes plugin contributions. Use for frontend or backend plugin changes to enforce local discovery, minimal scope, validation, and diff review.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/erxes/erxes/blob/HEAD/.agents/skills/plugin-workflow/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/plugin-workflow, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Skill: Plugin Contribution Workflow

Before Coding

  1. Read the root AGENTS.md and any nested AGENTS.md that applies to the touched path
  2. Understand plugin structure
  3. Find similar implementation
  4. Reuse existing patterns

During Coding

  1. Keep changes scoped
  2. Preserve architecture
  3. Preserve UX consistency
  4. Avoid unnecessary abstractions
  5. Keep components understandable

After Coding

  1. Run pnpm nx lint <plugin>
  2. Run pnpm nx build <plugin>
  3. Run pnpm nx test <plugin> when tests, test setup, or tested behavior were touched
  4. Fix introduced warnings
  5. Remove debug code
  6. Review final diff

After Pushing / PR

  1. Run pr-review-loop skill. The erxes repo uses AI reviewers (CodeRabbit, Sourcery, Claude Code Action, Kimi, SonarCloud). After every commit to a PR, you MUST poll for new comments, address every actionable item, wait for CI checks to pass, and loop until zero open comments and all checks green. Only then is the task done. Do not declare a task complete while PR comments are unresolved or CI is failing.

Engineering Expectations

  • Consistency over cleverness
  • Reuse over reinvention
  • Minimalism over overengineering
  • Repository patterns over personal preference