forked from ferdikoomen/openapi-typescript-codegen
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add some developer-facing documentation (#69)
Whenever I touch this project I don't remember how to perform the most common tasks, I figured let's document them.
- Loading branch information
Showing
2 changed files
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Developer documentation | ||
|
||
This document is for the developers of this project, not for the users. | ||
|
||
## Common commands | ||
|
||
Install the dependencies: | ||
|
||
``` | ||
npm install | ||
``` | ||
|
||
Build the project (doesn't run the tests): | ||
|
||
``` | ||
npm run build | ||
``` | ||
|
||
Run the tests (we have to build in order for the current code to be used): | ||
|
||
``` | ||
npm run build && npm run test | ||
``` | ||
|
||
Update the test snapshots (we have to build in order for the current code to be used): | ||
|
||
``` | ||
npm run build && npm run test -- -u | ||
``` |