Skip to content
Skills Library
Documents & office · Writing

contributing

/contributing

Use 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.

Licence
CC-BY-4.0
Last repository change
27.10.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
7
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 27.10.2026, without references to retired models or APIs.

Licence

CC-BY-4.0, otwarta.

What it does and when to use it

Use 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.

Original author description

Use 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.

How it works

  1. Ground rules
  2. Before you start: gather context
  3. Task index
  4. Validate before you finish
Original SKILL.md headings · 66 lines, 650 words
SKILL.md preview
---
name: contributing
description: Use 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.
---

# Contributing to Cloudflare Docs

This is the single skill to load for any change to the Cloudflare Docs repository. It does not contain the detail itself — it routes you to the right reference for the task in front of you. Read the reference that matches your task, then follow it.

Do not guess at conventions. The references below are the source of truth for how this repo expects content to be written, structured, and validated.

Canonical references override conflicting local patterns, especially for product section names, folders, and ordering.

## Ground rules

These apply to every task below.

- **This is an open-source, public repository.** Never put private Cloudflare information, secrets, credentials, internal URLs, or environment variable values into pages, code examples, commits, pull requests, comments, or anywhere else in this repository. If there is any doubt — even slight — about whether something is safe to publish, stop and ask the user.
- **Branch off the latest `production`.** Before starting work, create your branch from an up-to-date `production` commit (`git fetch origin` then branch from `origin/production`), unless the user asks for a different base. This repo's default branch is `production`, not `main`.
- **Never commit or push automatically.** Make the file changes, then ask the user whether they want to commit and push. Do not run `git commit` or `git push` unprompted.

## Before you start: gather context

When the source material is thin or ambiguous, pause and ask the user before writing. You need enough to write something accurate, not just well-formatted. Ask for whatever is missing:

- **Source of truth** — a PR, RFC, engineering spec, API schema, existing page, or product owner to verify behavior against. Do not invent technical claims.
- **Product and feature area** — which Cloudflare product, and where in that product the change belongs.
- **Audience and intent** — who reads this and what they are trying to do (get started, look something up, follow a procedure, understand a concept).
- **Availability** — plan availability (Free/Pro/Business/Enterprise) and lifecycle status (GA, Beta, Alpha).
- **Scope** — is this a new page, an edit, a restructure, or a changelog entry.

If the user already provided a clear spec or PR, proceed without interrogating them.

## Task index

Find your task and read the listed reference(s). Paths are relative to this skill directory unless prefixed with `.agents/`.

| Your task                                      | Read                                                                                                     |
| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| Write or edit a documentation page             | `references/writing-docs.md` (the authoring workflow — start here)                                       |
| Decide which `pcx_content_type` and page shape | `references/content-types.md`                                                                            |
| Decide how to present data / which component   | `references/choosing-components.md`                                                                      |
| Decide where a page belongs, redirects, reuse  | `references/information-architecture.md`                                                                 |
| Look up writing and formatting rules           | `.agents/references/style-guide.md` (canonical) and `.agents/references/procedures.md` for step-by-steps |
| Look up a component's props and examples       | `.agents/references/components.md`                                                                       |
| Add or edit a changelog entry                  | `references/changelog.md`                                                                                |
| Review docs / post PR suggestions              | `references/reviewing-docs.md`                                                                           |

The authoring workflow in `references/writing-docs.md` ties these together: gather context → locate where the page belongs → pick a content type → draft against the style guide → choose components for each piece of data → validate.

## Validate before you finish

Run validation after any content change. Match the command set to your environment — a full build is local-only.

```bash
pnpm run check              # Type-check: validates frontmatter schemas + Astro types
pnpm run build              # Full build: validates MDX parsing, image paths, internal links — LOCAL ONLY (times out in CI)
pnpm run format             # Auto-fix Prettier formatting on edited files
```

In CI (`CI=true`), skip `pnpm run build`; run `pnpm run check`, `pnpm run lint`, and `pnpm run format:core:check` only.

If you modified `public/__redirects`, also run:

```bash
pnpm exec tsm bin/validate-redirects.ts
```

Always run `pnpm run format` on files you touched — CI fails on unformatted content.
Files in this package (7)
  • SKILL.md 5 KB
  • references/changelog.md 4 KB
  • references/choosing-components.md 11 KB
  • references/content-types.md 5 KB
  • references/information-architecture.md 6 KB
  • references/reviewing-docs.md 13 KB
  • references/writing-docs.md 5 KB

Versions

RepositoryScoreLicence
This page · cloudflare/cloudflare-docs100CC-BY-4.0
butterbase-ai/butterbase-skills100MIT
blaizzy/mlx-vlm100MIT
emmgeede/gridselect100MIT
Jeff-Kazzee/github-skills100MIT
googlecloudplatform/race-condition100Apache-2.0
Dqz00116/skill-lib100MIT
iowarp/clio-core84BSD-3-Clause

Database snapshot: 13.11.2026 · package version f61a4a6b5fab (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100documentation-guide
    Guide documentation structure, content requirements, and project documentation best practices. Use when: creating README, documentation, docs folder, project setup, technical docs. Not for: generating docs mechanically from source — use /docgen; changelog entries — use…
  • 84documentation-guide
    引导文档结构、内容需求与项目文档的最佳实践。 Use when: 创建 README、撰写文档、规划 docs 目录、项目初始设置、技术文档。 Not for: 从源代码机械式生成文档——请用 /docgen;变更日志条目——请用 /changelog。 Keywords: README, docs, documentation, CONTRIBUTING, CHANGELOG, ARCHITECTURE, API docs, 文档, 说明文档, 技术文档.
  • 95docs-manager
    Documentation management workflow for MkDocs sites and standalone markdown files -- initialize, generate, update docs, and create change summaries. Use when asked to "create docs", "write README", "update documentation", "generate docs site", "write CONTRIBUTING", "manage…
  • 95docs-manager
    Documentation management workflow for MkDocs sites and standalone markdown files — initialize, generate, update docs, and create change summaries. Use when asked to "create docs", "write README", "update documentation", "generate docs site", "write CONTRIBUTING", "manage…
  • 100docs
    This skill should be used when the user asks about "documentation", "README", "CHANGELOG", "CONTRIBUTING", "ADR", "architecture decision record", "changelog format", "keep a changelog", "doc comments", "API documentation", or needs guidance on project documentation requirements.
  • 100documentation-structure
    Documentation architecture for this repository. Use when creating, updating, or reviewing README.md, CONTRIBUTING.md, or docs/ files. Covers separation of concerns, vendor documentation standards, cross-references, and validation.

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.