Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(snapshot): make return value as StoreWritable #308

Merged
merged 1 commit into from
Dec 15, 2023

Conversation

domosedov
Copy link
Contributor

Description

Checklist for a new method

  • 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 src/method-name/readme.md
    • Add header Patronum/MethodName
    • Add section with overloads, if have
    • Add Motivation, Formulae, Arguments and Return sections for each overload
    • Add useful examples in Example section for each overload
  • Add section to README.md in the repository root
    • Add method to the table of contents into correct category - [MethodName](#methodname) - description.
    • Add section ## MethodName
    • Add [Method documentation & API](/src/method-name) into section
    • Add simple example

@zerobias zerobias changed the base branch from main to release/v2.1.1 December 15, 2023 12:25
Copy link
Member

@zerobias zerobias left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! 👍

@zerobias zerobias added bug Something isn't working fix PullRequest that fixes something broken labels Dec 15, 2023
@zerobias zerobias merged commit b503166 into effector:release/v2.1.1 Dec 15, 2023
4 checks passed
zerobias added a commit that referenced this pull request Dec 15, 2023
* fix(snapshot): make return value as StoreWritable (#308)

* Fix `status` type (#316)

---------

Co-authored-by: Aleksandr Grigorii <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working fix PullRequest that fixes something broken
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants