This document provides guidelines for writing smart contracts in Solidity using the Foundry framework. It adapts concepts from TypeScript best practices to suit Solidity's unique type system, execution environment, and Foundry's tooling.
Guidelines for writing clean, maintainable, and human-readable code. Apply these rules when writing or reviewing code to ensure consistency and quality.
A GitHub README is the gateway to an open-source project, serving as the primary resource for users and contributors. It should clearly explain what the project does, how to use it, and how to get involved, all while being well-organized and engaging. This guide provides best practices for an LLM to write a README…