Skip to content

Commit 024e3f2

Browse files
clarify contributing file
1 parent f0690c2 commit 024e3f2

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,37 +14,47 @@ npm install
1414

1515
Everything has now been setup! You can now make your desired changes to the code.
1616

17-
# Test the code
17+
# Building
1818

19-
For manual testing, you can create a new project and run the command
19+
To build the code, you can run the command:
2020

2121
```sh
22-
npm install path/to/mysql-memory-server
22+
npx tsc
2323
```
2424

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.
2626

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:
2830

2931
```sh
30-
npm test
32+
npx tsc --noEmit
3133
```
3234

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
3436

35-
# Building
37+
For manual testing, build the code and then create a new project and run the command
3638

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:
3846

3947
```sh
40-
npx tsc
48+
npm test
4149
```
4250

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+
4353
# Submitting the pull request
4454

4555
Before submitting the pull request, please make sure the following are true:
4656
- All the automated tests pass
4757
- 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
4959

5060
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

Comments
 (0)