try-works/role-model / .agents/skills/contributing
contributing
VerifiedUse when contributing to the Cloudflare Docs repository — writing or editing documentation pages, choosing content types or components, adding changelog entries, reviewing docs, or learning how to contribute.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 5.1 KB |
| references/changelog.md | markdown | 3.7 KB |
| references/choosing-components.md | markdown | 11.2 KB |
| references/content-types.md | markdown | 5.1 KB |
| references/information-architecture.md | markdown | 4.1 KB |
| references/reviewing-docs.md | markdown | 13.3 KB |
| references/writing-docs.md | markdown | 4.3 KB |
references/changelog.md
View on GitHub# Changelog Entries
Use this reference when creating, editing, or reviewing changelog entries under `src/content/changelog/`.
**Style reference:** `.agents/references/style-guide.md` contains the canonical rules for writing style, formatting, links, code blocks, and frontmatter. The changelog-specific additions below extend those rules — they do not replace them.
## Prerequisites
You need three things before writing:
1. A **product name** (for example, Workers, KV, Hyperdrive, Containers, R2)
2. A **description of the change** being documented
3. Enough context to explain the "why" and use cases
If any are missing, ask for clarification. Do not proceed without all three.
## Determine the product folder
Use the product name to find the correct folder under `src/content/changelog/{product}/`. Check existing folders for valid product names — do not guess.
## Create the changelog file
Path format:
```
src/content/changelog/{product}/{YYYY-MM-DD}-{useful-short-name}.mdx
```
Use today's date and a concise, hyphenated slug describing the change.
## Frontmatter
```yaml
---
title: <TITLE>
description: <ONE_SENTENCE_SUMMARY>
products:
- <PRODUCT>
date: <YYYY-MM-DD>
---
```
## Writing style
Follow the rules in `.agents/references/style-guide.md`. Changelog-specific additions:
- Opening sentence: what the feature/change is and what problem it solves
- Expand on usage, use cases, and the "why" in subsequent paragraphs
- Assume a technical developer/cloud audience
## Code examples
Include a code example when the changelog describes an API, SDK, or configuration change.
- Keep snippets short and focused on the new feature — minimize boilerplate
- Import components after the frontmatter: `import { TypeScriptExample, WranglerConfig } from "~/components";`
- **Workers JS/TS** → use `TypeScriptExample` (not bare `js`/`ts` fences)
- **Wrangler config** → use `WranglerConfig` with TOML input and `$today` for `compatibility_date` (not bare `toml`/`jsonc` fences)
- **Other languages** (Python, Rust, Go, etc.) → use a plain fenced code block with the correct language identifier
- **Non-Workers config snippets** (JSON, YAML, etc.) → use a plain fenced code block (`json`, `yaml`, etc.)
## Documentation links
End the changelog with a link to relevant documentation:
- Use relative paths (for example, `/workers/configuration/placement/`)
- Link text must describe the destination — never "click here" or "read more"
- Check for uncommitted/staged `.md`/`.mdx` files that might be the related documentation
## Reference examples
Review these existing changelogs for style and format guidance:
- `src/content/changelog/workers/` - Workers changelogs with code examples
- `src/content/changelog/kv/` - KV changelogs
- `src/content/changelog/hyperdrive/` - Hyperdrive changelogs
- `src/content/changelog/containers/` - Container changelogs
Read 2-3 entries from the target product's changelog folder before writing to match style and depth. If the target folder has fewer than 2 entries, read from the folders listed above as a reference.
## Editing existing entries
When updating an existing changelog entry, preserve the original structure and voice. Apply only the requested changes — do not rewrite surrounding content.
## Reviewing changelog entries
When reviewing, validate against every section above: frontmatter fields, file path conventions, writing style, code example quality, and documentation links. Flag issues by severity:
- **Error**: Missing required frontmatter fields, wrong product folder, broken links
- **Warning**: Style violations, missing code examples for API changes, vague descriptions
- **Nit**: Minor phrasing improvements
## Output
Create or update the changelog file and show the complete file path and content.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation). | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK). | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |