Index: appengine/findit/predator/README.md |
diff --git a/appengine/findit/predator/README.md b/appengine/findit/predator/README.md |
new file mode 100644 |
index 0000000000000000000000000000000000000000..3a80f3115bf68fe930d0e5cbc6414105742f134f |
--- /dev/null |
+++ b/appengine/findit/predator/README.md |
@@ -0,0 +1,16 @@ |
+# Code structure |
+ |
+* [analysis](analysis): Core of analysis for Chrome crashes. |
wrengr
2016/11/10 21:20:35
-> "Core library for analyzing Chrome crashes."
stgao
2016/11/14 23:30:51
Done.
|
+* [app](app): The App Engine modules to provide core services of Predator. |
wrengr
2016/11/10 21:20:35
-> "The AppEngine application for invoking the lib
stgao
2016/11/14 23:30:51
Done. Removed "modules" and "services" as they mig
|
+ |
+# Refactoring guideline |
+* All core logic of analysis should live in [analysis](analysis), and it should |
+ be standalone, and not depend any App Engine APIs. |
+* All app-layer code should live in [app](app) |
+ * Frontend code rendering UIs to providing APIs for clients like |
+ ClusterFuzz/Fracas/Cracas should live in [app/frontend](app/frontend). |
+ * Backend code running the analysis should live in [app/backend](app/backend). |
+ * Shared code between the frontend and backend should live in [app/common](app/common). |
+ |
+# Next step |
+ When the refactoring is done, we will do a one-off move to appengine/predator. |