Merge main into sweep/add-evaluation-method

CI/CD configuration file

@@ -0,0 +1,27 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Cache Node.js modules
+      uses: actions/cache@v2
+      with:
+        path: ~/.pnpm-store
+        key: ${{ runner.OS }}-node-${{ hashFiles('**/pnpm-lock.yaml') }}
+        restore-keys: |
+          ${{ runner.OS }}-node-
+    - run: pnpm install
+    - run: pnpm eslint --fix "./**/*.ts" "./**/*.js"
+    - run: pnpm run test

CONTRIBUTING.md

@@ -31,11 +31,21 @@ PNPM's has documentation on its [workspace feature](https://pnpm.io/workspaces)
 
 ### Running Typescript
 
-When we publish to NPM we will have a tsc compiled version of the library in JS. For now, the easiest thing to do is use ts-node.
+When we publish to NPM we will have a tsc compiled version of the library in JS. For now, the easiest thing to do is use ts-node. To run a TypeScript file, use the following command:
+
+```
+pnpx ts-node {file_path}
+```
 
 ### Test cases
 
-To run them, run
+Before running the tests, compile the TypeScript files to JavaScript. This can be done by running the following command:
+
+```
+pnpm run build
+```
+
+After the build process is complete, you can run the tests with:
 
 ```
 pnpm run test

packages/core/src/QueryResponseEvaluator.ts

@@ -0,0 +1,12 @@
+import { Response } from './Response';
+import { BaseQueryEngine } from './QueryEngine';
+import { ResponseEvaluator } from './ResponseEvaluator';
+
+export class QueryResponseEvaluator {
+  evaluate(query: string, response: Response, queryEngine: BaseQueryEngine): number {
+    const evaluator = new ResponseEvaluator(queryEngine);
+    const binaryEvaluation = evaluator.binaryEvaluation(query, response);
+    const nodeEvaluation = evaluator.nodeEvaluation(query, response);
+    return binaryEvaluation && nodeEvaluation ? 1 : 0;
+  }
+}

packages/core/src/ResponseEvaluator.ts

@@ -0,0 +1,12 @@
+import { Response } from './Response';
+import { BaseNode } from './Node';
+
+export class ResponseEvaluator {
+  binaryEvaluation(response: Response, context: string): boolean {
+    return response.toString() === context;
+  }
+
+  nodeEvaluation(query: string, node: BaseNode): boolean {
+    return node.toString().includes(query);
+  }
+}