Skip to content

Commit 68e506e

Browse files
TMHSDigitalTMHSDigital
committed
feat: add AGENTS.md, fix badges, add CI workflows, rebuild Pages
Add AGENTS.md with repo structure and conventions. Make all README badges clickable with proper link targets. Add ci.yml workflow (pytest on Python 3.11/3.12). Add dependency-review.yml workflow. Rebuild docs site with fixed skill parser and QoL features. Made-with: Cursor
1 parent 39eb994 commit 68e506e

File tree

5 files changed

+755
-675
lines changed

5 files changed

+755
-675
lines changed

‎.github/workflows/ci.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
test:
14+
runs-on: ubuntu-latest
15+
strategy:
16+
matrix:
17+
python-version: ["3.11", "3.12"]
18+
steps:
19+
- uses: actions/checkout@v4
20+
21+
- uses: actions/setup-python@v5
22+
with:
23+
python-version: ${{ matrix.python-version }}
24+
25+
- name: Install dependencies
26+
run: pip install -r requirements-test.txt
27+
28+
- name: Run tests
29+
run: pytest tests/ -v

‎.github/workflows/dependency-review.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Dependency Review
2+
3+
on:
4+
pull_request:
5+
branches: [main]
6+
7+
permissions:
8+
contents: read
9+
pull-requests: write
10+
11+
jobs:
12+
dependency-review:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
- uses: actions/dependency-review-action@v4
17+
with:
18+
fail-on-severity: high
19+
comment-summary-in-pr: always

‎AGENTS.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# AGENTS.md
2+
3+
Guidance for AI coding agents working on the Monday Cursor Plugin repository.
4+
5+
## Repository overview
6+
7+
A Cursor IDE plugin for Monday.com integration. 21 skills and 8 rules covering boards, items, sprints, docs, dashboards, and GraphQL queries. 44 MCP tools for Monday.com API operations.
8+
9+
**Docs site:** https://tmhsdigital.github.io/Monday-Cursor-Plugin/
10+
11+
## Repository structure
12+
13+
```
14+
Monday-Cursor-Plugin/
15+
.cursor-plugin/plugin.json # Plugin manifest (name, version, description)
16+
skills/ # 21 skill directories, each with SKILL.md
17+
rules/ # 8 rule files (.mdc)
18+
mcp-tools.json # MCP tool catalog (44 tools, manually maintained)
19+
site.json # GitHub Pages branding/config
20+
docs/ # Generated GitHub Pages site (do not edit manually)
21+
assets/ # Logo and images
22+
tests/ # Test suite
23+
.github/workflows/ # CI/CD (codeql, pages, release-drafter, stale, validate)
24+
```
25+
26+
## Branching and commit model
27+
28+
- **Single branch:** `main` only
29+
- **Conventional commits:** `feat:`, `fix:`, `chore:`, `docs:`
30+
31+
## Skills
32+
33+
Each skill lives in `skills/<skill-name>/SKILL.md`. Every SKILL.md starts with YAML frontmatter:
34+
35+
```yaml
36+
---
37+
name: skill-name
38+
description: One-line description of what the skill does
39+
---
40+
```
41+
42+
The `name` and `description` fields are parsed by the site template build system to generate the GitHub Pages site. When adding a new skill:
43+
1. Create `skills/<skill-name>/SKILL.md` with frontmatter
44+
2. Update the `skills` count in `.cursor-plugin/plugin.json`
45+
3. Use `feat:` commit prefix
46+
47+
## Rules
48+
49+
Rules are `.mdc` files in `rules/`. Each starts with YAML frontmatter containing `description` and `globs` fields.
50+
51+
## MCP Tools
52+
53+
`mcp-tools.json` is a manually maintained JSON array of all MCP tools. Each entry has `name`, `description`, and `category` fields. This file is used by the GitHub Pages build system to render the tools catalog.
54+
55+
## GitHub Pages
56+
57+
The docs site is auto-generated. Do not edit `docs/index.html` directly. It is built by the shared template system from the Developer-Tools-Directory repo.
58+
59+
Data sources:
60+
- `.cursor-plugin/plugin.json` -- metadata
61+
- `site.json` -- branding (accent color, install steps, links)
62+
- `skills/*/SKILL.md` -- parsed for name/description via frontmatter
63+
- `rules/*.mdc` -- parsed for name/scope/description
64+
- `mcp-tools.json` -- tool catalog
65+
66+
The `pages.yml` workflow clones Developer-Tools-Directory, runs `build_site.py`, and deploys the output.
67+
68+
## CI/CD workflows
69+
70+
- `validate.yml` -- validates plugin.json schema
71+
- `pages.yml` -- builds and deploys GitHub Pages via shared template
72+
- `codeql.yml` -- security scanning
73+
- `release-drafter.yml` -- auto-drafts release notes
74+
- `stale.yml` -- marks/closes inactive issues and PRs
75+
76+
## Key conventions
77+
78+
- No em dashes or en dashes -- use hyphens or rewrite
79+
- No hardcoded credentials, tokens, or API keys
80+
- Conventional commits required
81+
- CC-BY-NC-ND-4.0 license
82+
- All content written for public readership

‎README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,22 @@
1010

1111
<!-- Row 1: Identity -->
1212
<p align="center">
13-
<img src="https://img.shields.io/badge/version-0.1.0-6C3EC6?style=flat-square" alt="Version" />
14-
<img src="https://img.shields.io/github/v/release/TMHSDigital/Monday-Cursor-Plugin?style=flat-square&color=6C3EC6" alt="Release" />
15-
<img src="https://img.shields.io/badge/license-CC--BY--NC--ND--4.0-4B286D?style=flat-square" alt="License" />
13+
<a href="https://github.com/TMHSDigital/Monday-Cursor-Plugin/releases"><img src="https://img.shields.io/badge/version-0.1.0-6C3EC6?style=flat-square" alt="Version" /></a>
14+
<a href="https://github.com/TMHSDigital/Monday-Cursor-Plugin/releases"><img src="https://img.shields.io/github/v/release/TMHSDigital/Monday-Cursor-Plugin?style=flat-square&color=6C3EC6" alt="Release" /></a>
15+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-CC--BY--NC--ND--4.0-4B286D?style=flat-square" alt="License" /></a>
1616
<a href="https://tmhsdigital.github.io/Monday-Cursor-Plugin/"><img src="https://img.shields.io/badge/docs-website-6C3EC6?style=flat-square" alt="Docs" /></a>
1717
</p>
1818

1919
<!-- Row 2: CI -->
2020
<p align="center">
21-
<img src="https://img.shields.io/github/actions/workflow/status/TMHSDigital/Monday-Cursor-Plugin/validate.yml?label=validate&style=flat-square" alt="Validate" />
22-
<img src="https://img.shields.io/github/actions/workflow/status/TMHSDigital/Monday-Cursor-Plugin/codeql.yml?label=codeql&style=flat-square" alt="CodeQL" />
21+
<a href="https://github.com/TMHSDigital/Monday-Cursor-Plugin/actions/workflows/validate.yml"><img src="https://img.shields.io/github/actions/workflow/status/TMHSDigital/Monday-Cursor-Plugin/validate.yml?label=validate&style=flat-square" alt="Validate" /></a>
22+
<a href="https://github.com/TMHSDigital/Monday-Cursor-Plugin/actions/workflows/codeql.yml"><img src="https://img.shields.io/github/actions/workflow/status/TMHSDigital/Monday-Cursor-Plugin/codeql.yml?label=codeql&style=flat-square" alt="CodeQL" /></a>
2323
</p>
2424

2525
<!-- Row 3: Community -->
2626
<p align="center">
27-
<img src="https://img.shields.io/github/stars/TMHSDigital/Monday-Cursor-Plugin?style=flat-square&color=4B286D" alt="Stars" />
28-
<img src="https://img.shields.io/github/issues/TMHSDigital/Monday-Cursor-Plugin?style=flat-square&color=4B286D" alt="Issues" />
27+
<a href="https://github.com/TMHSDigital/Monday-Cursor-Plugin/stargazers"><img src="https://img.shields.io/github/stars/TMHSDigital/Monday-Cursor-Plugin?style=flat-square&color=4B286D" alt="Stars" /></a>
28+
<a href="https://github.com/TMHSDigital/Monday-Cursor-Plugin/issues"><img src="https://img.shields.io/github/issues/TMHSDigital/Monday-Cursor-Plugin?style=flat-square&color=4B286D" alt="Issues" /></a>
2929
</p>
3030

3131
<!-- Row 4: Counts -->

0 commit comments

Comments
 (0)