open-digger
open-digger copied to clipboard
[feature] Add a description of the file structure of the repo to the document
Adding the description of the file structure of the warehouse to the document is friendly to first-time contributors.
Do you mean this one https://github.com/X-lab2017/github-analysis-report/blob/master/docs/csv/data_description.csv ? If you don't understand any column of the data description, feel free to tell us about it.
Sorry, I didn't express it clearly. I'm talking about the file or folder of the code, not the description of the data. The following:
github-analysis-report
│ .gitignore
│ CONTRIBUTING.md
│ CONTRIBUTORS
│ LICENSE
│ LICENSE-CC-BY
│ README.md
│ REPORT.md
│ REPORT_TEMPLATE.md
│ tree.txt
│
├─.github
│ │ hypertrons.json
│ │
│ └─hypertrons-components
│ ├─auto_update_contribution
│ │ config.ts
│ │ defaultConfig.ts
│ │ index.lua
│ │ version.json
│ │
│ ├─auto_update_report
│ │ config.ts
│ │ defaultConfig.ts
│ │ index.lua
│ │ version.json
│ │
│ ├─sql_run
│ │ config.ts
│ │ defaultConfig.ts
│ │ index.lua
│ │ version.json
│ │
│ └─sql_verified
│ config.ts
│ defaultConfig.ts
│ index.lua
│ version.json
│
├─docs
│ │ .nojekyll
│ │ architecture.md
│ │ CONTRIBUTING.md
│ │ DATA.md
│ │ index.html
│ │ README.md
│ │ report.md
│ │ word-cloud.html
│ │ workflow.md
│ │ _coverpage.md
│ │ _navbar.md
│ │ _sidebar.md
│ │
│ ├─csv
│ │ data_description.csv
│ │
│ ├─diagrams
│ │ architect.uml
│ │ pull-flow.uml
│ │
│ ├─pic
│ │ database_table_1.png
│ │ databse_table_2.png
│ │ GHArchive_raw_data.png
│ │
│ └─zh-cn
│ .nojekyll
│ architecture.md
│ CONTRIBUTING.md
│ README.md
│ workflow.md
│ _coverpage.md
│ _sidebar.md
│
└─sqls
├─activity-repo-top
│ manifest.json
│ post-processor.js
│ sql
│
├─total-developer-count
│ manifest.json
│ post-processor.js
│ sql
│
├─total-record-count
│ manifest.json
│ post-processor.js
│ sql
│
├─total-repo-count
│ manifest.json
│ post-processor.js
│ sql
│
└─working-hour-distribution
image.svg
manifest.json
post-processor.js
sql
Great idea, I will add the file structure of the project after refactor the project.
/self-assign