Conversation
cs-raj
requested review from
aman19K,
harshitha-cstk,
netrajpatel,
reeshika-h and
sunil-lakshman
|
|
||
| ## References | ||
|
|
||
| - [`skills/dev-workflow/SKILL.md`](../dev-workflow/SKILL.md) — CI and branch rules. |
There was a problem hiding this comment.
@cs-raj, Why are we referring to these skill files if they are already mentioned in agents.md?
|
|
||
| ## References | ||
|
|
||
| - [`skills/csharp-style/SKILL.md`](../csharp-style/SKILL.md) — layout and naming in this repo. |
There was a problem hiding this comment.
@cs-raj, Why are we referring to these skill files if they are already mentioned in agents.md?
|
|
||
| ## References | ||
|
|
||
| - [`skills/contentstack-utils/SKILL.md`](../contentstack-utils/SKILL.md) — what belongs in the public API. |
There was a problem hiding this comment.
@cs-raj, Why are we referring to these skill files if they are already mentioned in agents.md?
|
|
||
| ## References | ||
|
|
||
| - [`skills/testing/SKILL.md`](../testing/SKILL.md) — test project and coverage. |
There was a problem hiding this comment.
@cs-raj, Why are we referring to these skill files if they are already mentioned in agents.md?
Can't we move the common references in the Agents.md file to avoid redundant declarations?
| ## Using Cursor (optional) | ||
|
|
||
| If you use **Cursor**, [`.cursor/rules/README.md`](.cursor/rules/README.md) only points to **[`AGENTS.md`](AGENTS.md)** at the repo root. All conventions live in **`skills/*/SKILL.md`**—same docs as for any other tool. |
There was a problem hiding this comment.
@cs-raj This should not be included in Agents.md. We can have this in cursor rules.
| ## When to use which skill | ||
|
|
||
| | Skill folder | Use when | | ||
| |--------------|----------| | ||
| | [`dev-workflow`](dev-workflow/SKILL.md) | Branch rules, local build/pack, test scripts, CI workflows, versioning, security scans, CODEOWNERS, Talisman. | | ||
| | [`testing`](testing/SKILL.md) | Writing or running xUnit tests, fixtures, mocks, coverage, matching CI behavior. | | ||
| | [`code-review`](code-review/SKILL.md) | Preparing or reviewing PRs, release/docs expectations, dependency risk. | | ||
| | [`contentstack-utils`](contentstack-utils/SKILL.md) | Public API (`Utils`, GQL helpers, variants, `Options`), NuGet package boundaries, converters, dependencies. | | ||
| | [`csharp-style`](csharp-style/SKILL.md) | Where to put new types, namespaces, naming consistency, multi-target framework constraints. | |
There was a problem hiding this comment.
@cs-raj This is redundant with Agents.md block
5 participants
Summary
Adds a repo-wide agent and contributor guide (
AGENTS.md), askills/tree with YAML-frontmatterSKILL.mdfiles, and a Cursor pointer (.cursor/rules/README.md) so editor-specific config does not duplicate canonical docs.Documentation is repo-specific (dotnet CLI, xUnit, Coverlet, GitHub Actions, branch rules, NuGet) and includes explicit inventories (interfaces, enums, models, mocks, JSON fixtures) instead of vague shorthand.
The Contentstack Utils API skill includes code flow sections (RTE
JsonToHtml, GQL edges,RenderContent, variant metadata) with Mermaid diagrams and pointers intoUtils.cs,HtmlDocumentExtension, andMetadata.Changes
Entry and index
AGENTS.md— Project purpose, stack, commands (including quickdotnet test Contentstack.Utils.sln), CI workflow table, skills index, Cursor note.skills/README.md— When to use each skill.Skills (
skills/<name>/SKILL.md)dev-workflow— Branch policy (staging→master), build/pack, test scripts, workflows, CODEOWNERS, Talisman, publish secrets wording.testing— Test project packages, test-class map, Resources and mocks (explicit files), quick local test, coverage and CI alignment.code-review— PR checklist and security notes.contentstack-utils— Package and namespaces, models and interfaces, rendering hooks, variants JSON path, Code flows and diagrams, authoritative-source line.csharp-style— Folder and file-level inventory for library layout.Cursor
.cursor/rules/README.md— Points toAGENTS.mdonly.Motivation
Notes
.cursorpointer); no application code changes in this workstream.