mirror of
https://github.com/ptarmiganlabs/butler-sos.git
synced 2025-12-19 17:58:18 -05:00
add guidance for Copilot on code style and testing practices
This commit is contained in:
14
docs/README.codestyle.md
Normal file
14
docs/README.codestyle.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# 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.
|
||||
9
docs/README.testing.md
Normal file
9
docs/README.testing.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# README.testing.md
|
||||
|
||||
This file provides guidance to Copilot about testing practices in this repository.
|
||||
|
||||
## Unit tests
|
||||
|
||||
- Verify tests work after creation new test files.
|
||||
- Do not fix linting or formatting issues in tests. These will be handled later using other tools.
|
||||
- Run tests using "npm run test".
|
||||
Reference in New Issue
Block a user