Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ with the contributing guidelines (found in the CONTRIBUTING.md file).

- [ ] Unit tests
- [ ] Documentation is up to date
- [ ] Regenerate README if a new matcher has been added to `/docs/README.template.md` (`yarn generate-readme`)
- [ ] No additional lint warnings
- [ ] Add yourself to contributors list (`yarn contributor`)
- [ ] [Typescript definitions](https://github.com/jest-community/jest-extended/blob/master/types/index.d.ts) are added/updated where relevant
7 changes: 6 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,12 @@ Head over to [here](https://hacktoberfest.digitalocean.com/sign_up/register) to
* See the Jest docs for an [example usage](https://facebook.github.io/jest/docs/en/expect.html#thisutils)
- Jest's [`expect`](https://github.com/facebook/jest/tree/master/packages/expect) package is being used to access their deep `equals` function.
* `import { equals } from 'expect/build/jasmine_utils';`
- Docs for the new matcher should be updated in the API section of the `README.md` to no longer say `Unimplemented`.
- Docs for new matchers should be added to `/docs/sandbox/matchers/[matcher.test.js]`, with a comment explaining the matcher and a code example of how to use the matcher.
- To add the matcher to the README you will need to link the docs in `docs/README.template.md` with the following syntax:
```
{{/sandbox/matchers/myNewMatcherName.test.js}}
```
- Once you have linked it in the template you can regenerate the README by running `yarn generate-readme`.
- Type definitions for the new matchers should be added to `types/index.d.ts`.

## Committing and Pushing changes
Expand Down
Loading