Not unexpectedly in a large project with many contributers there seems
to be more than a few dead directories (with source no longer relevent
to the browser) or test directories which either no longer compile or
do not function. Needless to say this is very confusing and
frustrating for developers not familiar with the source / history.
As a developer who writes plugins, components, and embedded browser
I've stumbled upon many dead-ends in the source (for instance trying to
locate a test embedded browser or a working plugin). I've since found
much of what I've been looking for through an exhaustive process (and
exhausting at that). This process is compounded by the fact that there
is not direct linkage between much of the source as much of it comes
together as components.
Perhaps I don't know where to look but it seems that we need / should
do the following:
- prune the source tree
One idea would be to create a checkout set which elides the non-
functional directories.
- have a readme or equiv in each directory
Should have a few lines describing the purpose of the directory
source.
- high-level source & component map
Basic document which diagrams the various components and their basic
relationships.
For me the top item, that of pruning the directory structure and the
bottom item of showing a high-level component relationship structure
would be invaluable.
Thanks
---
Jonathan Shore
CTO
E-Publishing Group Inc
Sent via Deja.com
http://www.deja.com/
