OpenWaterFoundation / owf-app-infomapper-ng

Open Water Foundation InfoMapper web application for menu-driven maps and visualizations, using Angular
GNU General Public License v3.0
1 stars 2 forks source link

What happens to README files in code folders? #358

Open smalers opened 3 years ago

smalers commented 3 years ago

Comments in code are helpful to understand the application design. Describing in developer documentation is also useful. It may also make sense to add README files to folders so that someone looking through the repository has a basic explanation of what is contained in the folder including things such as naming conventions.

However, it may not be desirable to distribute the README files in the deployment. So, if README files are created, are they ignored or are they packaged with the deployed application? If they are ignored, then I suggest adding more README files to folders. If they are packaged, then we may need to rely on developer documentation, code comments, and the main README file.