1 min read


Every workspace is required to have a README.md file in the root of the workspace.
Table of Contents

Conformance is available on Enterprise plans

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.

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.

Last updated on July 25, 2024