|
| 1 | +# Monday Cursor Plugin -- Contributor Conventions |
| 2 | + |
| 3 | +## Plugin Structure |
| 4 | + |
| 5 | +- Skills live in `skills/<skill-name>/SKILL.md` (kebab-case directory names) |
| 6 | +- Rules live in `rules/<rule-name>.mdc` (kebab-case filenames) |
| 7 | +- All skill and rule names start with `monday-` |
| 8 | +- Plugin manifest: `.cursor-plugin/plugin.json` |
| 9 | +- Logo: `assets/logo.png` |
| 10 | + |
| 11 | +## Skill Format |
| 12 | + |
| 13 | +Every SKILL.md must have: |
| 14 | +1. YAML frontmatter with `name` (matching directory name) and `description` (>= 20 chars) |
| 15 | +2. Sections in this order: |
| 16 | + - `# <Title>` |
| 17 | + - `## Trigger` |
| 18 | + - `## Required Inputs` |
| 19 | + - `## Workflow` |
| 20 | + - `## Key References` |
| 21 | + - `## Example Interaction` |
| 22 | + - `## MCP Usage` |
| 23 | + - `## Common Pitfalls` |
| 24 | + - `## See Also` (relative links to other skills: `../other-skill/SKILL.md`) |
| 25 | + |
| 26 | +## Rule Format |
| 27 | + |
| 28 | +Every .mdc rule must have: |
| 29 | +1. YAML frontmatter with `description` and `alwaysApply` (boolean) |
| 30 | +2. If `alwaysApply: false`, must include `globs` array |
| 31 | +3. Body sections: Patterns to Flag, What to Do, Exceptions |
| 32 | + |
| 33 | +## MCP Tool Naming |
| 34 | + |
| 35 | +- Reference Monday MCP tools by their exact names (e.g., `create_board`, `get_board_info`) |
| 36 | +- For operations not covered by dedicated MCP tools, provide `all_monday_api` GraphQL recipes |
| 37 | +- Document which MCP tools each skill uses in the MCP Usage table |
| 38 | + |
| 39 | +## Content Rules |
| 40 | + |
| 41 | +- No em dashes; use double hyphens `--` instead |
| 42 | +- No hardcoded API tokens or secrets in any file |
| 43 | +- Column value JSON examples must use the column ID as the outer key, not the type name |
| 44 | +- GraphQL examples should use variables for dynamic values |
| 45 | + |
| 46 | +## Release Checklist |
| 47 | + |
| 48 | +When releasing a new version: |
| 49 | +1. Bump version in `.cursor-plugin/plugin.json` |
| 50 | +2. Update skill/rule counts in `plugin.json` description |
| 51 | +3. Update CHANGELOG.md with Added/Changed/Fixed sections |
| 52 | +4. Update README.md counts and tables |
| 53 | +5. Update CLAUDE.md tables |
| 54 | +6. Update ROADMAP.md status |
| 55 | +7. Update `docs/index.html` stats |
| 56 | +8. Run `pytest tests/ -v` and verify all pass |
| 57 | +9. Tag the release: `git tag v<version>` |
| 58 | +10. Create GitHub release with changelog |
0 commit comments