appengine/findit/predator/README.md - Issue 2488113005: [Findit] Re-org code.

Keyboard Shortcuts

	File
u :	up to issue
j / k :	jump to file after / before current file
J / K :	jump to next file with a comment after / before current file
	Side-by-side diff
i :	toggle intra-line diffs
e :	expand all comments
c :	collapse all comments
s :	toggle showing all comments
n / p :	next / previous diff chunk or comment
N / P :	next / previous comment
<Up> / <Down> :	next / previous line

	Issue
u :	up to list of issues
j / k :	jump to patch after / before current patch
o / <Enter> :	open current patch in side-by-side view
i :	open current patch in unified diff view

	Issue List
j / k :	jump to issue after / before current issue
o / <Enter> :	open current issue

Unified Diff: appengine/findit/predator/README.md

Issue 2488113005: [Findit] Re-org code. (Closed)

Patch Set: Address comments. Created 4 years, 1 month ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

« appengine/findit/libs/http/test/__init__.py ('K') | « appengine/findit/model/wf_config.py ('k') | appengine/findit/predator/__init__.py » ('j') | appengine/findit/predator/__init__.py » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

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..00c83d5f911a7df4cf213c9ef68a2a4d2e821c1b

--- /dev/null

+++ b/appengine/findit/predator/README.md

@@ -0,0 +1,15 @@

+# Code structure

+* [analysis](analysis): Core library for analyzing Chrome crashes.

+* [app](app): The App Engine app to provide web APIs to analyze Chrome crashes through invoking the core library above, and web pages to view & monitor analysis results.

wrengr 2016/11/15 00:38:01 nit: line too long

stgao 2016/11/16 18:44:11 This is OK for text file, but not for code file.

+# 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.

« appengine/findit/libs/http/test/__init__.py ('K') | « appengine/findit/model/wf_config.py ('k') | appengine/findit/predator/__init__.py » ('j') | appengine/findit/predator/__init__.py » ('J')