diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 00000000..38944ae8 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,10 @@ +This is a TypeScript-based repository with a Ruby client for certain API endpoints. It includes several sub projects called addons which are built separately. It contains a demo application which showcases the functionality of the project. + +Please follow these guidelines when contributing: + +## Development Flow + +- Install dependencies: `npm install && npm run setup` +- Build and bundle demo: `npm run build && npm run esbuild` +- Run unit tests: `npm run test-unit` +- Run playwright-based integration tests: `npm run test-integration`