pr-template-guide

A guide for writing pull request descriptions using the repository's official template. A pull request is a request to review and merge code or documentation changes.

In plain words
What is it for?
Use it for every pull request, including content edits, new pages, tool changes, and dependency updates.
Why use it?
It prevents descriptions from being placed in the wrong section and keeps change details consistent across the project.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/sumologic/sumologic-documentation/pr-template-guide
Any agent
npx skills add SumoLogic/sumologic-documentation --skill pr-template-guide
Clone the repo
git clone --depth 1 https://github.com/SumoLogic/sumologic-documentation

Made for: Claude Code, Codex.

Per session 0 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,195 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.02195
Opus 5 $0.00000 $0.01097
Sonnet 5 $0.00000 $0.00439
Haiku 4.5 $0.00000 $0.00219

Measured 2d ago against content hash b41ed3e8e7a2, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

pr-template-guide scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.claude/skills/pr-template-guide/SKILL.md · 279 lines

How it starts

The opening of the file, as written. The whole thing — 279 lines — stays where its author put it; the contents beside it link to each section on GitHub.

PR Template Guide — Universal Reference

This document provides guidance on formatting PR descriptions according to the repository's official PR template. Use this for ALL pull requests, regardless of what changed or how the changes were made.

KEY RULE: All PR descriptions and bulleted lists of changes appear AFTER the "## Purpose of this pull request" heading, BEFORE the "## Select the type of change" heading.

Official PR Template

Located at .github/PULL_REQUEST_TEMPLATE.md:

## Purpose of this pull request

This pull request... <!-- brief description here -->


## Select the type of change
<!-- What types of changes does your code introduce? Select the checkbox after clicking "Create pull request" button. -->

- [ ] Minor Changes - Typos, formatting, slight revisions
- [ ] Update Content - Revisions, updating sections
- [ ] New Content - New features, sections, pages, tutorials
- [ ] Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

## Ticket (if applicable)

<!-- enter your Jira, Asana, or GitHub ticket number -->

When to Use This Template

ALWAYS - Use this template format for any PR creation:

  • Creating new documentation or pages
  • Updating existing documentation
  • Fixing typos or formatting issues
  • Adding release notes
  • Updating dependencies or site configuration
  • Any other repository changes

Change Type Selection Guide

Choose the appropriate checkbox based on the work:

✅ New Content

Use when:

  • Creating new documentation pages
  • Adding new app integration docs
  • Adding new release notes
  • Creating new features or tutorials
  • Adding entirely new sections

✅ Update Content

Use when:

  • Revising existing documentation
  • Updating instructions or procedures
  • Fixing documentation quality issues
  • Improving existing content
  • Adding information to existing pages

✅ Minor Changes

Use when:

  • Fixing typos or grammar
  • Correcting formatting
  • Making small text revisions
  • Quick fixes that don't change meaning

Read the full file on GitHub · 279 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 279 lines · 0 tokens per session scan A b41ed3e8e7a2

Subscribe to this mod's changes

pr-template-guide is a skill published in the GitHub repository SumoLogic/sumologic-documentation (42 stars, last pushed 4d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 2,195 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

gr-readme

🇺🇸 GitHub README Writing System — Craft a README that converts visitors to stars in <3 seconds. Proven structure from AFFiNE's 0→60K star journey: tagline engineering, first-screen law, section-by-section copywriting guide, Claude Code integration section, anti-patterns, and a pre-publish checklist. Use when you…

Gingiris-1031/gingiris-skills · 458 tokens

developer-marketing-playbook

Complete developer marketing playbook covering DevRel programs, documentation as marketing, API developer experience, community building, and hackathon strategy. For dev-tool founders who need to reach engineers. Follow @WeiYipei on X.

Gingiris-1031/gingiris-skills · 51 tokens

devrel-playbook

Complete Developer Relations playbook — from community building to documentation strategy to event planning. Covers Discord/Slack management, conference speaking, hackathon sponsorship, and measuring DevRel ROI. By @WeiYipei.

Gingiris-1031/gingiris-skills · 47 tokens

go-swagger3-docs

Documents existing Go HTTP APIs with go-swagger3 godoc @ annotations and struct tags, then generates OpenAPI 3 specs. Use when the user asks to document an API, add Swagger/OpenAPI comments, generate oas.json/yml, or mentions go-swagger3.

parvez3019/go-swagger3 · 63 tokens

README Writer

Generates a professional, comprehensive README.md for any project from its codebase or description.

Notysoty/openagentskills · 21 tokens

repo-audit

Audit a repository or prepare it for an open-source release. Audit mode reports whether the README matches the code and whether stated rules are actually enforced; launch mode walks a repo to release-ready with opt-in checklist packs and README templates. Use when asked to "audit this repo," "is this repo ready to go…

conorbronsdon/repo-audit · 112 tokens