Skip to content

Commit

Permalink
Add a note on partial definitions
Browse files Browse the repository at this point in the history
  • Loading branch information
gantoine committed Nov 29, 2021
1 parent 913b628 commit cdc4445
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/contributing.md
Expand Up @@ -68,6 +68,12 @@ This tells the test runner to ignore errors that mention that line. **We require
`// $FlowExpectedError` in each test**. This helps to ensure that the test is actually
exercising types like the author expects it to be.

## Partial/definitions definitions

We welcome contributions of partial, incomplete or work-in-progress definitions!
When submitting a partial definition, please stub out the missing parts with `any`.
If the definition was generated from `create-stub`, those parts should already be stubbed.

## A note on flowgen

[flowgen](https://github.com/joarwilk/flowgen) is a CLI tool that generates flowtype definitions from TypeScript types.
Expand Down

0 comments on commit cdc4445

Please sign in to comment.