archive/phabricator
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

some fixes for code layout doc

Browse Source 
Summary: use arc layout, include about the __tests__ folder, upsell unit testing

Test Plan: read the docs!

Reviewers: epriestley

Reviewed By: epriestley

CC: aran

Differential Revision: https://secure.phabricator.com/D2235
This commit is contained in:
Bob Trahan
2012-04-14 07:05:29 -07:00
parent 5b32a19a08
commit 304948f039
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/docs/developer/phabricator_code_layout.diviner
View File

@@ -16,7 +16,7 @@ The Phabricator infrastructure knows where a given controller class lives on
disk from a cache file the Arcanist phutil mapper generates. This mapping disk from a cache file the Arcanist phutil mapper generates. This mapping
should be updated whenever new classes or files are added: should be updated whenever new classes or files are added:
/path/to/arcanist/scripts/phutil_mapper.php /path/to/phabricator/src arc liberate /path/to/phabricator/src
Finally, a given controller class will map to an application which will have Finally, a given controller class will map to an application which will have
most of its code in standardized subdirectories and classes. most of its code in standardized subdirectories and classes.
@@ -118,11 +118,12 @@ corresponding classes
- **DerpViewController**: typically extends ##DerpBaseController## and displays - **DerpViewController**: typically extends ##DerpBaseController## and displays
a single ##Derp##. a single ##Derp##.
NOTE: each directory will have a class file with an ##__init__.php## or Some especially awesome directories might have a ##__tests__## subdirectory
subdirectories; never both. containing all pertinent unit test code for the class.
= Next Steps = = Next Steps =
- Learn about @{article:Adding New CSS and JS}; or - Learn about @{article:Adding New CSS and JS}; or
- learn about the @{class:LiskDAO}; or - learn about the @{class:LiskDAO}; or
- learn about @{article:Writing Unit Tests}; or
- learn how to contribute (see @{article:Contributor Introduction}). - learn how to contribute (see @{article:Contributor Introduction}).