Skip to main content

documentation-policy

Use when adding or reviewing significant features, make options or commands, CI workflows, or scoped AGENTS.md files.

跳到安装

来源信息

仓库
DataDog/dd-trace-go
最近来源活动
2026年9月10日 15:40
检测到的 SKILL.md 语言
英语
星标
854
分支
550

安装方式

默认使用会先检查来源的 Prompt;你也可以切换为直接命令,或下载本地副本。

检查来源文件

决定是否安装前,请先阅读 SKILL.md,以及 SkillsMP 当前展示的配套文件。

正在显示 SKILL.md

SKILL.md
来源说明 · 只读预览
name
documentation-policy
description
Use when adding or reviewing significant features, make options or commands, CI workflows, or scoped AGENTS.md files.
user-invocable
false
metadata
{"internal":true}
## Updating Documentation The root [AGENTS.md](/AGENTS.md) should be short. Only update it if a new scoped `AGENTS.md` file is added, so it can be added to the list with its purpose. Document changes in the nearest existing doc: the package's [Go doc comment](https://go.dev/doc/comment) or `doc.go` for API/behavior, the closest `README.md` (e.g. [`contrib/README.md`](/contrib/README.md)) for an area, or [`FAQ.md`](/FAQ.md)/[`MIGRATING.md`](/MIGRATING.md) for user-facing notes. The developer should update [`CONTRIBUTING.md`](/CONTRIBUTING.md) with new, significant features. A feature is significant when: 1. It introduces a new method of interacting with and/or customizing the tracer (ie new scripts for generating files, options for configuration sources, etc) 2. A new internal functionality is introduced that can replace a common, built-in Go library 3. The `make` command supports a new flag that introduces new testing/linting/building functionality AND/OR 4. A new CI workflow in GitHub or GitLab is created The developer should also update [README.md](/README.md) with new options to the `make` command and other important commands that are essential for testing or building the tracer. If these updates are not made, tell the developer to make changes or provide suggestions if requested.
在 GitHub 查看