agentleFS
bazel-contribbazel-contrib/rules_python/.agents/skills/create-news/SKILL.md

create-news

Skill692 starsChanged 6 days agoApache-2.0View on GitHub

Create or update a concise news entry file in `news/` for

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

5 rules. About 0 are common, 1 is distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use this skill when adding or editing a news fragment in news/.

    line 7
  2. Very specific:

    Create a news file only for released, user-visible changes (added, changed, fixed, removed).

    line 16
  3. Very specific:

    Never edit CHANGELOG.md directly for unreleased changes.

    line 20
  4. Very specific:

    If no issue or PR exists yet, use a short, hyphenated descriptive term (e.g., py-typed-pyi-srcs.added.md).

    line 24
  5. Distinctive:

    Keep the entry to 1-2 concise sentences stating *what* changed for users.

    line 30

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Use this skill when adding or editing a news fragment in news/. News entries are combined into CHANGELOG.md at release time and must be short snippets that are easy to skim and grok.

@.agents/rules/news.md

Workflow

  1. Determine if a News Entry is Needed:
    • Create a news file only for released, user-visible changes (added, changed, fixed, removed).
    • Skip news files for internal refactoring, test-only changes, or fixes to unreleased code.
    • Never edit CHANGELOG.md directly for unreleased changes.
  2. Choose the Filename (news/<id>.<category>.md):
    • <id>: Use the GitHub issue or PR number if one exists (e.g., 4181). If no issue or PR exists yet, use a short, hyphenated descriptive term (e.g., py-typed-pyi-srcs.added.md). Never use 0000 or generic placeholders.
    • <category>: Choose added, changed, fixed, or removed.
  3. Draft a Short, Skimmable Snippet:
    • Keep the entry to 1-2 concise sentences stating what changed for users.
    • Prefix with the subsystem in parentheses when applicable (e.g., (pypi), (toolchains), (gazelle), (bzlmod)).
    • Omit leading bullet points (* or -).
    • Cut implementation mechanics, internal helper names, and secondary edge-case explanations; put detailed usage in API docstrings instead.
    • Wrap lines at 80 columns.
    • Append issue/PR links at the end when applicable: ([#1234](https://github.com/bazel-contrib/rules_python/issues/1234)).

Examples

Good (concise and skimmable):

(toolchains) Added the
{obj}`--@rules_python//python/config_settings:py_pbs_distribution` flag to
select stripped `python-build-standalone` runtime archives
([#4163](https://github.com/bazel-contrib/rules_python/issues/4163)).
(coverage) Skip lcov report generation when no coverage data is collected.

Bad (too verbose and detailed):

(pypi) A {obj}`pip.parse` call for a Python version that has no interpreter for
the host platform is now skipped, like a version with no registered toolchain,
instead of failing the whole {obj}`pip` extension. A dependency that lists,
say, Python 3.9 no longer breaks every other hub on hosts that have no CPython
3.9 build, such as Windows on ARM64
([#4184](https://github.com/bazel-contrib/rules_python/issues/4184)).

(Rewrite: (pypi) Skip {obj}\pip.parse` calls for Python versions without a host interpreter instead of failing the {obj}`pip` extension (#4184).`)

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.