Skip to content
Back to skills

2602 Contributing Docs 3a79106b

ASecurity

- Style: Use Google-style docstrings for public functions, classes, and modules. - Local preview: `pip install -e '.[docs]'` then `make docs-serve`. - Build check: `make docs-build` (uses `--strict`). - PRs: Docs workflow builds for pull requests; deploy happens only on `main`.

  • 9 stars
  • 0 votes
  • 0 copies
  • 0 views
  • Added October 11, 2026
developmentpythongoapi

Works with

  • api

Security analysis

A92/100
  • mediumInstalls packages at runtime which could introduce malicious dependencies

Pro shows the line behind each finding and how to fix it

Scanned October 11, 2026

npx -y skills add tools-only/X-Skills --skill 2602-contributing-docs_3a79106b --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of 2602 Contributing Docs 3a79106b?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for 2602 Contributing Docs 3a79106b
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/tools-only-2602-contributing-docs-3a79106b/badge)](https://www.skillsdirectory.com/skills/tools-only-2602-contributing-docs-3a79106b)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

SKILL.md
# Contributing to Docs

- Style: Use Google-style docstrings for public functions, classes, and modules.
- Local preview: `pip install -e '.[docs]'` then `make docs-serve`.
- Build check: `make docs-build` (uses `--strict`).
- PRs: Docs workflow builds for pull requests; deploy happens only on `main`.

## Style (Project Conventions)

- Naming: snake_case for functions/commands/tools; PascalCase for classes/dataclasses.
- Decorators: use bare `@command`/`@tool` when no options; use `@command(...)`/`@tool(...)` when passing options.
- Typing: prefer `@command(output=T)` for precise static types; when `output` is omitted, static return is `str` (async → `Awaitable[str]`).
- Imports: use top-level `from alloy import ...` (stubs apply) for public API; avoid submodule imports in examples.
- Docstrings: concise, imperative summaries; short examples with snake_case.

## Docstring example (Google style)

```python
def add(a: int, b: int) -> int:
    """Add two integers.

    Args:
      a: First number.
      b: Second number.

    Returns:
      The sum of a and b.
    """
    return a + b
```

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.