diff --git a/docs/react-v9/contributing/api-extractor.md b/docs/react-v9/contributing/api-extractor.md new file mode 100644 index 0000000000000..2e553744e31f9 --- /dev/null +++ b/docs/react-v9/contributing/api-extractor.md @@ -0,0 +1,15 @@ +### What is API Extractor? + +[API Extractor](https://api-extractor.com/) generates an api.md file containing the public API for a package. `@fluentui/react` and related packages as well as `@fluentui/web-components` use API Extractor to ensure that API changes must be reviewed before being merged into master. (`@fluentui/react-northstar` and related packages do not use API Extractor as of writing.) + +### Build Tasks + +As part of a package's build process, the api-extractor task checks the package's public API with the package's auto-generated .api.md file. Be sure to commit the updates with your other changes + +In PR builds, the task will fail if it detects missing API file updates. + +To generate the API markdown file commit your changes, then run: + +`yarn nx run :build` + +Commit and push the updated file.