---
title: "package-comments"
description: "Require package documentation."
image: "https://strider.gempir.com/og.png"
---

> Documentation Index
> Fetch the complete documentation index at: https://strider.gempir.com/llms.txt
> Use this file to discover all available pages before exploring further.

# package-comments

<!-- Code generated by docs/scripts/generate-check-docs.go; DO NOT EDIT. -->

**Default severity:** `note`

Require package documentation.

## Bad

```go
package store
```

## Good

```go
// Package store persists application data.
package store
```

Source: https://strider.gempir.com/lints/package-comments/index.mdx