Skip to content

Commit

Permalink
docs: pr template should contains src dir
Browse files Browse the repository at this point in the history
  • Loading branch information
sergeysova authored Oct 9, 2021
1 parent bab3d73 commit bd08c91
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

### Checklist for a new method

- [ ] Create directory for new method in root in `param-case`
- [ ] Place code to `method-name/index.ts` in ESModules export in `camelCase` **named** export
- [ ] Add tests to `method-name/method-name.test.ts`
- [ ] Add **fork** tests to `method-name/method-name.fork.test.ts`
- [ ] Create a directory for the new method in the `src` directory in `param-case`
- [ ] Place the source code to `src/method-name/index.ts` in ESModules export in `camelCase` **named** export
- [ ] Add tests to `src/method-name/method-name.test.ts`
- [ ] Add **fork** tests to `src/method-name/method-name.fork.test.ts`
- [ ] Add **type** tests to `test-typings/method-name.ts`
- Use `// @ts-expect-error` to mark expected type error
- `import { expectType } from 'tsd'` to check expected return type
- [ ] Add documentation in `method-name/reade.md`
- [ ] Add documentation in `src/method-name/reade.md`
- Add header `Patronum/MethodName`
- Add section with overloads, if have
- Add `Motivation`, `Formulae`, `Arguments` and `Return` sections for each overload
Expand Down

0 comments on commit bd08c91

Please sign in to comment.