search

betsyCC / OAREDA_Syntax_Library

MIT License
1 stars 7 forks source link

SUGGESTION - add README files to EVERY folder #3

Open betsyrosalen opened 2 years ago

betsyrosalen commented 2 years ago

I highly recommend that we add a README.md file to EVERY folder to store instructions and explanations about the code for each task. This is much easier to read and more prominently featured than adding comments to the code for things that do not necessarily refer directly to lines of code. Thoughts?

CBLITTMAN-OAREDA commented 1 year ago

I agree that every folder should have a README file for general information about the contents of the folder. But I also think that code comments are essential for users to understand what the code is doing when it may not be obvious, especially to newer analysts.