From cdc4445301bc0245977e286bf557aa83d586c728 Mon Sep 17 00:00:00 2001 From: Georges-Antoine Assi Date: Mon, 29 Nov 2021 09:57:01 -0500 Subject: [PATCH] Add a note on partial definitions --- docs/contributing.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/contributing.md b/docs/contributing.md index cece5e3d23..e5d5fbf116 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -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.