---
title: PACKAGE_MANAGEMENT_REQUIRED_README
product: vercel
url: /docs/conformance/rules/PACKAGE_MANAGEMENT_REQUIRED_README
type: conceptual
prerequisites:
  []
related:
  []
summary: Every workspace is required to have a README.md file in the root of the workspace.
install_vercel_plugin: npx plugins add vercel/vercel-plugin
---

# PACKAGE_MANAGEMENT_REQUIRED_README

> **🔒 Permissions Required**: Conformance

A `README.md` file helps orient readers to the purpose of a workspace and
instructions how to use it, which makes it straightforward for people browsing the code
to understand its purpose, whether they should use it, and how to make changes
to the code.

## How to fix

Add a `README.md` file in the workspace directory. This file can contain a
description of the package, and any instructions for developers or users to
build or use the package.


---

[View full sitemap](/docs/sitemap)