Skip to content

Commit d94d6e3

Browse files
Copilotjasonjoh
andauthored
Add npm run test step to README.md workflows for local testing before committing (#1244)
* Initial plan * Add npm run test step to README.md workflows Co-authored-by: jasonjoh <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: jasonjoh <[email protected]>
1 parent f77dc59 commit d94d6e3

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ POST Example includes headers, post body and a tip <br>
6767
When done making the changes on the document,
6868
1. Save the document on your machine
6969
1. Create a Git branch on this repo and name it using your initials + describe the changes ie. bn/add-xyz-samples
70+
1. Run `npm run test` to test your changes locally
7071
1. Commit the changes to your branch
7172
1. Create a PR (the PR is automatically updated with the relevant reviewers).
7273

@@ -114,15 +115,18 @@ Then in the new Git command line window, paste in this command to create and che
114115
### 4. Update your sample query
115116
Now you can add, update or delete your sample query in the `sample-queries.json` file that opened up in VS Code earlier.
116117

117-
### 5. Add, commit and push your changes back to the remote repo with the following commands
118+
### 5. Test your changes locally
119+
Run `npm run test` to test your changes locally before committing.
120+
121+
### 6. Add, commit and push your changes back to the remote repo with the following commands
118122
- Add the changes to you local repo: `git add sample-queries.json`
119123
- Commit your changes: `git commit -m "{add-reason-for-update}"`
120124
- Push your changes to the remote repo: `git push origin {your-branch-name}`
121125

122-
### 6. Login to GitHub
126+
### 7. Login to GitHub
123127
Follow the instructions to login to GitHub using your credentials.
124128

125-
### 7. If you get error 403
129+
### 8. If you get error 403
126130
Follow the instructions specified, then run this command again:<br/>
127131
`git push origin {your-branch-name}`
128132

0 commit comments

Comments
 (0)