You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+11-25Lines changed: 11 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,21 +4,20 @@
4
4
5
5
AlaSQL is an open source SQL database for JavaScript with a focus on query speed and data source flexibility for both relational data and schemaless data. It works in web browsers, Node.js, and mobile apps.
-`dist/` - Built distribution files (generated, not committed)
11
-
-`test/` - Test files following `test###.js` naming pattern where ### is typically the issue number or test###-B if the testfilenumber is already taken.
12
-
-`types/` - TypeScript type definitions
13
-
-`docs/` - Documentation
14
-
-`examples/` - Example usage code
15
-
16
-
7
+
## When Implementing Features
17
8
9
+
1.**Understand the issue thoroughly** - Read related test cases and existing code
10
+
2.**Write a test first** - Create `test/test###.js` for the issue where `###` is the id of the issue we are actually fixing.
11
+
3.**Verify test fails** - Run `yarn test` to confirm the test catches the issue
12
+
4.**Implement the fix** - Modify appropriate file(s) in `src/`
13
+
5.**Format code** - Run `yarn format` before committing
14
+
6.**Verify test passes** - Run `yarn test` again
18
15
19
16
20
-
### Creating Tests
21
-
2. Name new test files as `test/test###.js` where `###` is the GitHub issue number if applicable
17
+
## How to to test files
18
+
1. Make a test file
19
+
- Name new test files as `test/test###.js` where `###` is the GitHub issue number of the issue we are actually fixing.
20
+
- If the file already exists we name the file test/test###-B.js
22
21
1. Copy the structure in `test/test000.js` as a template
23
22
3. Tests should be self-contained and clear about what they're testing
24
23
4. Use the Mocha test framework with standard assertions
@@ -48,17 +47,6 @@ yarn build
48
47
- `src/alasqlparser.js` - Generated from Jison grammar (modify the `.jison` file instead)
49
48
- `.min.js` files - Generated during build
50
49
51
-
### Node.js Version
52
-
- Requires Node.js >= 20 for building
53
-
54
-
## When Implementing Features
55
-
56
-
1. **Understand the issue thoroughly** - Read related test cases and existing code
57
-
2. **Write a test first** - Create `test/test###.js`for the issue
58
-
3. **Verify test fails** - Run `yarn test` to confirm the test catches the issue
59
-
4. **Implement the fix** - Modify appropriate file(s) in`src/`
60
-
5. **Format code** - Run `yarn format` before committing
0 commit comments