tag:blogger.com,1999:blog-9238405.post112991626103591114..comments2024-03-18T02:04:50.380-07:00Comments on Agile Testing: Proper location for LICENSE, CHANGELOG and other files?Grig Gheorghiuhttp://www.blogger.com/profile/17863511617654196370noreply@blogger.comBlogger4125tag:blogger.com,1999:blog-9238405.post-1130029698170832672005-10-22T18:08:00.000-07:002005-10-22T18:08:00.000-07:00I can see some justification for LICENSE (though I...I can see some justification for LICENSE (though I don't include any license document anywhere in any of my projects). README always strikes me as funny and incomplete. Half the time it's just a pointer elsewhere. Other times it's an incomplete and sometimes inaccurate abbreviated document, that summarizes what the "real" intro documentation says. At least PKG-INFO has useful structure, if you are looking for pointers.<BR/><BR/>As a result, I put everything in docs/, and you can see everything by looking in that directory. Not in project subdirectories, subcomponents don't have their own subcomponent/docs/ directories (they might have docs/subcomponent/, though). <BR/><BR/>I'm bad at change logs, but then as a user I find a news file generally more useful anyway (and as a developer I try to be at least a little better about generating those files).Ian Bickinghttps://www.blogger.com/profile/10921115783730718101noreply@blogger.comtag:blogger.com,1999:blog-9238405.post-1130015592131794542005-10-22T14:13:00.000-07:002005-10-22T14:13:00.000-07:00a README and setup.py should be all that are requi...a README and setup.py should be all that are required in the main directory.<BR/><BR/>LICENSE and ChangeLog should be more mobile; why the heck do you need them in the top-level directory?? I never look at 'em anyway until I'm actively involved in the development of a project...Anonymousnoreply@blogger.comtag:blogger.com,1999:blog-9238405.post-1129923286400195652005-10-21T12:34:00.000-07:002005-10-21T12:34:00.000-07:00Main directory. It's good to make them obvious, an...Main directory. It's good to make them obvious, and it fits with the convention that most (non-Python) projects use -- esp. since autoconf requires them in those places.EYhttps://www.blogger.com/profile/14163554987019555889noreply@blogger.comtag:blogger.com,1999:blog-9238405.post-1129920944314259742005-10-21T11:55:00.000-07:002005-10-21T11:55:00.000-07:00Top level = fewer keystrokes to read the durn thin...Top level = fewer keystrokes to read the durn things, which if you admin a lot, is an issue of some consequence. Also, having primary docs obvious quite possibly results in fewer "RTFM-type" inquiries...Anonymousnoreply@blogger.com