Open velialiev opened 6 months ago
My suggestion is to write test(s) And small motivation text(aka your case for example for explanation for other potential users)
P.S. yes I know that defer is a common practice but still applicable example will be very much appreciated
Added default pull request template to help making new operator
Description
https://github.com/effector/patronum/issues/329
(Why we should add this method?)
Checklist for a new method
src
directory inparam-case
src/method-name/index.ts
in ESModules export incamelCase
named exportsrc/method-name/method-name.test.ts
src/method-name/method-name.fork.test.ts
test-typings/method-name.ts
// @ts-expect-error
to mark expected type errorimport { expectType } from 'tsd'
to check expected return typesrc/method-name/readme.md
Patronum/MethodName
Motivation
,Formulae
,Arguments
andReturn
sections for each overloadExample
section for each overloadsrc/method-name/readme.md
title
. Make sure it uses camelCase syntax just like the method itselfslug
. Use param-case to write it. In most cases it will be just liketitle
desription
with one short sentence describing what method useful forgroup
. To categorize method on/operators
page. Full list of available groups, you can see in documentation/src/content/config.ts