search

moja-global / Handbook

https://moja-global.github.io/Handbook/
4 stars 12 forks source link

Addition of Project Structure in the FLINT Handbook Readme #19

Closed BhaswatiRoy closed 1 year ago

BhaswatiRoy commented 1 year ago

The readme of this repository can include a detailed project structure like the following -

image

What needs to be included -

  1. Folders and files contained in each folder
  2. Comments giving briefing about the functioning and workings of each folder
  3. Detailed overall view of entire project

Advantages -

  1. Gives an edge to first-time contributors to understand what each section contains
  2. Avoids linear searching time for required files
  3. Makes the contribution process easier
BhaswatiRoy commented 1 year ago

I can work on this issue!