Burke --
The OpenMRS README file only describes the project layout, it is not useful
for understanding the purpose of OpenMRS. What level of detail would you
expect in the file, given that the most detailed information would be on the
wiki?
From: [email protected] [mailto:[email protected]] On Behalf Of Burke Mamlin
Sent: Friday, May 18, 2012 10:59 AM
To: [email protected]
Subject: [OPENMRS-DEV] In search of README for modules
Devs,
Could we migrate toward a convention of using a README file at the root of each
module? I know there's a place for a description in the config.xml, but it's
not very friendly when trying to scan through
modules<http://svn.openmrs.org/openmrs-modules/> and understand their purpose.
And I'm sure an improved module repository will help some day, but not all
modules make it into the module repository.
For example, adopt a convention of placing a README (e.g., one of README,
README.txt, README.md) containing a description of the module in the root of
each module's tree (or in trunk/ if the module uses the trunk/, branches/,
tags/ folder convention). This is already a prevailing convention in open
source coding, right?
OpenMRS has a "readme.txt" file in trunk. We could use the same for contribs.
Thoughts?
-Burke
________________________________
Click here to
unsubscribe<mailto:[email protected]?body=SIGNOFF%20openmrs-devel-l>
from OpenMRS Developers' mailing list
