mirror of
https://github.com/cloudflare/skills.git
synced 2026-09-14 16:49:26 +08:00
docs: keep skill maintenance grounded in developer docs
This commit is contained in:
@@ -0,0 +1,13 @@
|
||||
# Contributing
|
||||
|
||||
Keep skills small: help agents find the right documentation instead of maintaining another copy of it.
|
||||
|
||||
For changes to skills, commands, or bundled references:
|
||||
|
||||
- Read the relevant page on [Cloudflare's developer documentation](https://developers.cloudflare.com/) and verify that it supports the proposed guidance; a working URL alone is not enough.
|
||||
- Link directly to the relevant product or workflow page. Prefer links over duplicated API signatures, limits, pricing, configuration, or examples that can become stale.
|
||||
- When correcting outdated reference content, replace it with a short pointer to the current documentation where possible.
|
||||
- If the required guidance is missing from `developers.cloudflare.com`, describe the documentation gap in the pull request rather than adding unsupported guidance to a skill.
|
||||
- Include the source URLs you checked and any validation performed in the pull request description.
|
||||
|
||||
The maintainers listed in [CODEOWNERS](CODEOWNERS) own review of these changes. Keep documentation maintenance with the affected change.
|
||||
Reference in New Issue
Block a user