Skip to content

Commit cc90e3c

Browse files
authored
Merge branch 'doc-contributing' into copilot/sub-pr-5762
2 parents 2fbb287 + 16e0db9 commit cc90e3c

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,12 @@ Thanks for your interest in improving Web Chat. We invest heavily in engineering
4040
<!-- Verify if we need this
4141
- macOS: add execute permission by `chmod +x ./chromedriver` and remove quarantine flag `xattr -d com.apple.quarantine ./chromedriver`
4242
-->
43-
3. Run `npm clean-install`
44-
4. Run `npm run build-browser`
45-
5. Run `npm run browser`
43+
4. Run `npm clean-install`
44+
5. Run `npm run build-browser`
45+
6. Run `npm run browser`
4646
- This will start a new Chrome session with banner saying the browser is controlled by automation
4747
- This browser is solely for development purpose, do not use it for personal browsing
48-
6. Verify the setup: use the new Chrome session and navigate to http://localhost:5001/__tests__/html2/simple/contentSecurityPolicy.html
48+
7. Verify the setup: use the new Chrome session and navigate to http://localhost:5001/__tests__/html2/simple/contentSecurityPolicy.html
4949
- It should show a green checkmark
5050

5151
### Start coding
@@ -97,7 +97,7 @@ We love VRTs. Majority of our tests prioritize snapshot testing over assertion/e
9797
To create VRTs, inside your Codespace:
9898

9999
- Keep the `npm start` running
100-
- Start a container swarm with hosted Chrome
100+
- Start Docker Compose/Selenium Grid with hosted Chrome
101101
1. Start a new terminal
102102
2. `npm run docker`
103103
3. Verify the setup: browse to http://localhost:4444/wd/hub/status
@@ -116,19 +116,19 @@ Chrome render slightly different. The changing factors include versions of the h
116116

117117
### Why my pull request is failing?
118118

119-
Our CI pipeline use the very same build/test script. When you run `npm test` in your Codespace, you should be able to figure out which tests are failing.
119+
Our CI pipeline uses the very same build/test script. When you run `npm test` in your Codespace, you should be able to figure out which tests are failing.
120120

121121
There are a few reasons:
122122

123123
- Failing static code analysis
124124
- Run `npm run precommit` and check for errors
125125
- Flaky tests
126126
- Test infrastructure is down
127-
- All of use share the same test infrastructure, it will be rebuilt every weekend or on-demand
127+
- All of us share the same test infrastructure, it will be rebuilt every weekend or on-demand
128128

129-
Before filing a ticket for us to investigate CI issues, please checkout the `main` branch without your change. If the tests are passing in `main` but failing in yours, then it is very likely a problem in the new code.
129+
Before filing a ticket for us to investigate CI issues, please check out the `main` branch without your change. If the tests are passing in `main` but failing in yours, then it is very likely a problem in the new code.
130130

131-
### How long does all tests takes to run?
131+
### How long does it take to run all tests?
132132

133133
> At the time of writing, we have about 1,700 screenshots and 1,200 integration tests.
134134
@@ -156,7 +156,7 @@ Our philosophy:
156156

157157
This is for the best interest of everyone.
158158

159-
### Can I add a feature that is only available to certain demography of customers?
159+
### Can I add a feature that is only available to a certain demographic of customers?
160160

161161
No, please create your own private fork and distribution channel.
162162

0 commit comments

Comments
 (0)