From b1e16f64bd46cd3bef3ba54cf9f1b49ee24afa87 Mon Sep 17 00:00:00 2001
From: Ying Liu <yingliufb@meta.com>
Date: Tue, 31 Jan 2023 13:07:24 -0800
Subject: [PATCH] Add pyre external (#1000)

Summary:
Pull Request resolved: https://github.com/pytorch/torchrec/pull/1000

ATT following https://www.internalfb.com/intern/staticdocs/pyre/docs/fb/open-source-setup/

Reviewed By: colin2328

Differential Revision: D42891790

fbshipit-source-id: 447346889f54eb704f727389f511d5371a820c34
---
 .pyre_configuration | 11 +++++++++++
 README.MD           | 20 ++++++++++++++++++++
 2 files changed, 31 insertions(+)
 create mode 100644 .pyre_configuration

diff --git a/.pyre_configuration b/.pyre_configuration
new file mode 100644
index 000000000..a4c321891
--- /dev/null
+++ b/.pyre_configuration
@@ -0,0 +1,11 @@
+{
+  "exclude": [
+    ".*/pyre-check/stubs/.*"
+  ],
+  "site_package_search_strategy": "all",
+  "source_directories": [
+    "torchrec"
+  ],
+  "strict": true,
+  "version": "0.0.101674562297"
+}
diff --git a/README.MD b/README.MD
index 69c40d6ca..2aee8363c 100644
--- a/README.MD
+++ b/README.MD
@@ -93,5 +93,25 @@ We are currently iterating on the setup experience. For now, we provide manual i
 
 5. If you want to run a more complex example, please take a look at the torchrec [DLRM example](https://github.com/facebookresearch/dlrm/blob/main/torchrec_dlrm/dlrm_main.py).
 
+## Contributing
+
+### Pyre and linting
+
+Before landing, please make sure that pyre and linting look okay. To run our linters, you will need to
+```
+pip install pre-commit
+```
+
+, and run it.
+
+For Pyre, you will need to
+```
+cat .pyre_configuration
+pip install pyre-check-nightly==<VERSION FROM CONFIG>
+pyre check
+```
+
+We will also check for these issues in our GitHub actions.
+
 ## License
 TorchRec is BSD licensed, as found in the [LICENSE](LICENSE) file.