butler-sos/docs/README.codestyle.md

README.codestyle.md

This file provides guidance to Copilot about code style and conventions in this repository.

Formatting and indentation of files

DO NOT fix code indentation or formatting as part of work done by Copilot.
Other tools will handle that.

JSDoc comments

• Describe what the function does
• List all parameters, including (if possible) what properties object parameters have
• List possible return values, including Promises and data types. Insert empty line between parameters and return value descriptions.