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: CONTRIBUTING.md
+21-11Lines changed: 21 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,37 +14,47 @@ npm install
14
14
15
15
Everything has now been setup! You can now make your desired changes to the code.
16
16
17
-
# Test the code
17
+
# Building
18
18
19
-
For manual testing, you can create a new project and run the command
19
+
To build the code, you can run the command:
20
20
21
21
```sh
22
-
npm install path/to/mysql-memory-server
22
+
npx tsc
23
23
```
24
24
25
-
replacing "path/to/mysql-memory-server" with the path to this repository on your computer. You can then write code that uses `mysql-memory-server` and test your changes.
25
+
Building the code will change the files in the `dist` folder. Before committing your changes, please make sure no changes from the `dist` folder end up in the commit.
26
26
27
-
There are also automated tests which you can run by running the command:
27
+
The `dist` folder is only modified when a new version of this package is published to npm.
28
+
29
+
If you just want to check that there are no build errors without modifying the `dist` folder's files, you can run the command:
28
30
29
31
```sh
30
-
npm test
32
+
npx tsc --noEmit
31
33
```
32
34
33
-
Please do not run the `npm run test:ci` command to test your code locally. That command is meant to only be used in disposable CI environments.
35
+
# Test the code
34
36
35
-
# Building
37
+
For manual testing, build the code and then create a new project and run the command
36
38
37
-
To build the code, you can run the command:
39
+
```sh
40
+
npm install path/to/mysql-memory-server
41
+
```
42
+
43
+
replacing "path/to/mysql-memory-server" with the path to this repository on your computer. You can then write code that uses `mysql-memory-server` and test your changes.
44
+
45
+
There are also automated tests which you can run by running the command:
38
46
39
47
```sh
40
-
npx tsc
48
+
npm test
41
49
```
42
50
51
+
Please do not run the `npm run test:ci` command to test your code locally. That command is meant to only be used in GitHub Actions.
52
+
43
53
# Submitting the pull request
44
54
45
55
Before submitting the pull request, please make sure the following are true:
46
56
- All the automated tests pass
47
57
- There are no build errors
48
-
- Your commits do not contain any changes from the `dist` folder (this folder is only modified whenever a new version of this package is published to npm)
58
+
- Your commits do not contain any changes from the `dist` folder
49
59
50
60
Now that your change has been made, it's time to commit and push your code to your forked repository. Once that's done, you can create a pull request. You can learn more about that [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
0 commit comments