Skip to content

Commit 50a521e

Browse files
authored
docs: updates to contribution.md (#4383)
Corrected some words, added links. In the case of `hand written` this should be spelled as `hand-written` or `handwritten`. [See](https://ell.stackexchange.com/questions/128289/how-to-spell-correctly-hand-written-or-handwritten#:~:text=Handwritten%20and%20hand%2Dwritten%20are,but%20lost%20that%20in%20years.)
1 parent 0e1a55a commit 50a521e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

.github/CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,7 @@ describe('Menu', () => {
390390
})
391391
```
392392

393-
The last argument to a common test is always `options`. You can configure the test here. Example, if your component requires certain props to render, you can pass in `requiredProps`:
393+
The last argument to a common test is always `options`. You can configure the test here. For example, if your component requires certain props to render, you can pass in `requiredProps`:
394394

395395
```js
396396
import * as common from 'test/specs/commonTests'
@@ -419,7 +419,7 @@ This is the only required test. It ensures a consistent baseline for the framew
419419

420420
### Visual testing
421421

422-
We are using [Percy](https://percy.io/) and Cypress to perform visual testing of our components. To create a new visual
422+
We are using [Percy](https://percy.io/) and [Cypress](https://www.cypress.io/) to perform visual testing of our components. To create a new visual
423423
test there should an example in our docs that can be served by Cypress and a corresponding Cypress test, for example:
424424
- `cypress/integration/Popup/Popup.visual.js` contains visual tests
425425
- `docs/src/examples/modules/Popup/Visual/PopupVisualInsideModal.js` contains an example that will be used for visual
@@ -437,7 +437,7 @@ function MyComponent(props) {
437437
}
438438
```
439439

440-
If you're component requires event handlers, it is a stateful class component. Want to know [why][15]?
440+
If your component requires event handlers, it is a stateful class component. Want to know [why][15]?
441441

442442
```js
443443
class MyComponent extends Component {
@@ -464,7 +464,7 @@ TODO
464464
- [Props](#props)
465465
- [Examples](#examples)
466466

467-
Our docs are generated from docblock comments, `propTypes`, and hand written examples.
467+
Our docs are generated from docblock comments, `propTypes`, and hand-written examples.
468468

469469
### Website
470470

0 commit comments

Comments
 (0)