add guidance for Copilot on code style and testing practices

This commit is contained in:
Göran Sander
2025-09-24 20:28:44 +02:00
parent d48e98d1a2
commit 62da06ad3d
3 changed files with 37 additions and 11 deletions

14
docs/README.codestyle.md Normal file
View 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
View 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".