OpenParable
Skip to content
← Back to skills

Adding Changelog Entries

Documents
adding-changelog-entries

Adding Changelog Entries is an Agent Skill for documents published in the flutter/devtools repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Use when documenting changes in CHANGELOG.md files for devtools_shared, devtools_app_shared, or devtools_extensions.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/flutter/devtools/blob/HEAD/.agents/skills/adding-changelog-entries/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/adding-changelog-entries, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Adding Changelog Entries

When adding changelog entries to published packages (devtools_shared, devtools_app_shared, and devtools_extensions), follow these rules:

  • Check Publication State: Never add an entry to an already published version (e.g. # 12.1.0). You MUST check which versions are published on pub.dev (e.g., at https://pub.dev/packages/<package_name>/versions) before determining section headers! If a version is not yet published, it should be suffixed with the next numeric -wip tag (e.g., ## 0.5.1-wip) or follow the existing convention in the file, such as (not released). You should also match the existing header level (H1 or H2) used for versions in that file. Avoid generic placeholder headers like # WIP!
  • New Version Headers: If a version bump is required, you MUST first use the instructions in updating-package-versions to update the package version in pubspec.yaml, and then add a new header to the changelog file with the new version (e.g., ## 0.5.1-wip) before adding your entries.
  • Accurately Distinguish Packages: Ensure that the cleanups or edits applied to a specific package's changelog entries belong strictly to that package path (e.g., changes in devtools_app do not warrant entries in devtools_shared).
  • Conciseness and Accuracy: Describe clearly what was changed and why. Avoid generic descriptions without context, such as "Fixes missing deprecation message". Indicate specifically what was added or removed.
  • User visible changes ONLY: Only add entries in the changelog if the change is meaningful to consumers of the package. Do not include internal refactoring notes or other trivial changes that users do not care about.