Code Formatting Guidelines

VerifiedSafe

A compact set of code formatting guidelines for consistency, readability, and automated tooling.

Sby Skills Guide Bot
DevelopmentBeginner
7/22/2026
Claude CodeCursorWindsurfCopilotCodex
#code-formatting#linting#editor-config#code-review#legacy-code

Recommended for

Automated summary

This skill provides a compact set of code formatting guidelines covering readability goals, editor integration, and handling of legacy code.

Strengths

  • States clear, concrete goals: readability, code review, fewer unnecessary diffs
  • Offers practical editor integration advice (format on save, .editorconfig, Unix line endings)
  • Proposes a realistic incremental strategy for legacy code instead of a mass reformat commit
  • Short and easy to scan, so it costs little context

Limitations

  • Contains no ready-to-use configuration or commands for black or ruff, only principles
  • Implicitly targets Python without saying so, which limits usefulness for other languages
  • Deliberately artificial document used as a test fixture for token counting
When to use it

Use it to quickly frame a team's formatting conventions and how formatters plug into the editor.

When not to use it

Avoid it if you need complete config files or rules for a language other than Python.

Security analysis

Safe
Quality score72/100

The skill contains only static code-formatting guidance. It declares no tools, executes no commands, accesses no network or files, and includes no destructive, exfiltration, or obfuscated instructions.

No concerns found

How this analysis is made

Examples

Set up shared formatting
Write an .editorconfig for our Python repo and tell me how to enable format-on-save so everyone uses the same black and ruff settings.
Legacy code reformatting plan
Our repo has lots of code that doesn't match black's style. Give me a plan to converge without one massive reformatting commit.
Team formatting guidelines
Draft a short formatting guideline section for our team handbook: line length, imports, and what humans vs automated tools should handle.

name: small-skill description: Small skill with basic content for token testing license: MIT

Small Skill: Code Formatting Guidelines

This skill describes a compact but realistic set of code formatting guidelines. It is used in tests that measure token counts for skill metadata versus full content. The text is intentionally longer than the template skill so that the savings from progressive disclosure are obvious when only the lightweight metadata is injected into the system prompt.

Goals of Consistent Formatting

  • Make code bases readable by any team member.
  • Reduce cognitive load when switching between files.
  • Minimize unnecessary diffs during code review.
  • Allow automated tools such as black and ruff to do most of the work.

When formatting is predictable, reviewers can focus on the substance of a change instead of spending time commenting on indentation, line length, or import ordering. A good rule of thumb is that humans should spend their attention on naming, structure, and correctness, while automated tools enforce the small mechanical rules.

Editor Integration

Most developers experience formatting rules through their editor or IDE. To keep friction low:

  1. Enable "format on save" for the primary language server.
  2. Configure the same line length in both the formatter and linter.
  3. Make sure the editor uses UTF‑8 and Unix line endings by default.
  4. Share editor configuration files (such as .editorconfig) in the repository.

The important part is that everyone on the team runs the same tools with the same configuration. If a project uses black, developers should not disable it locally or override its defaults in surprising ways.

Handling Legacy Code

In real projects there is almost always some legacy code that does not match the current formatting rules. A practical approach is:

  • Avoid reformatting the entire repository in a single massive commit.
  • Instead, reformat files as they are touched for real changes.
  • For large refactors, coordinate with the team so that merges remain manageable.

This incremental strategy allows teams to converge toward a consistent style without breaking every open feature branch. The tests in this repository treat this document as a "small" skill that still contains enough natural language to produce a meaningful token count.

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/code-formatting-guidelines-mrwakfqg/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/code-formatting-guidelines-mrwakfqg' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/code-formatting-guidelines-mrwakfqg/download' --output '.skill-downloads/code-formatting-guidelines-mrwakfqg/SKILL.md.part' && mv '.skill-downloads/code-formatting-guidelines-mrwakfqg/SKILL.md.part' '.skill-downloads/code-formatting-guidelines-mrwakfqg/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

Claude Code
test -f '.skill-downloads/code-formatting-guidelines-mrwakfqg/SKILL.md' && test -s '.skill-downloads/code-formatting-guidelines-mrwakfqg/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/small-skill' && cp -R '.skill-downloads/code-formatting-guidelines-mrwakfqg' '.claude/skills/small-skill'

Cursor
test -f '.skill-downloads/code-formatting-guidelines-mrwakfqg/SKILL.md' && test -s '.skill-downloads/code-formatting-guidelines-mrwakfqg/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/small-skill' && cp -R '.skill-downloads/code-formatting-guidelines-mrwakfqg' '.cursor/skills/small-skill'

Codex
test -f '.skill-downloads/code-formatting-guidelines-mrwakfqg/SKILL.md' && test -s '.skill-downloads/code-formatting-guidelines-mrwakfqg/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/small-skill' && cp -R '.skill-downloads/code-formatting-guidelines-mrwakfqg' '.agents/skills/small-skill'

OpenSkills

OpenSkills must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/code-formatting-guidelines-mrwakfqg'

openskills read 'code-formatting-guidelines-mrwakfqg'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/code-formatting-guidelines-mrwakfqg/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills