Merge pull request #10 from chrisreddington/instructions-and-tsdocs

Enhance documentation and add copilot instructions

Author: chrisreddington

.github/copilot-instructions.md

@@ -0,0 +1,14 @@
+# Core Requirements
+
+- The end goal is to create a custom GitHub Action which validates the
+  devcontainer.json of a given repository.
+
+## Code Quality Requirements
+
+- Follow standard TypeScript conventions and best practices
+- Use clear, descriptive variable and function names
+- Add comments to explain complex logic or non-obvious implementations
+- Include TSDoc comments throughout the code.
+- Write unit tests for core functionality
+- Keep functions focused and manageable (generally under 50 lines)
+- Use error handling patterns consistently

__tests__/index.test.ts

@@ -4,6 +4,10 @@ jest.mock('../src/main', () => ({
   run: jest.fn()
 }))
 
+/**
+ * Test suite for the GitHub Action's entry point.
+ * Validates that the action is properly initialized and the main run function is called.
+ */
 describe('index', () => {
   it('calls run when imported', async () => {
     await import('../src/index')