@@ -38,9 +38,12 @@ See [`CONTRIBUTING.md`][org-contrib].
3838
3939[ org-contrib ] : https://github.com/creativecommons/.github/blob/main/CONTRIBUTING.md
4040
41- ### Project Structure
42- Please note that in the directory tree below, all instances of ` fetch ` , ` process ` , and ` report ` are referring to
43- the three phases of data gathering, processing, and report generation.
41+
42+ ### Project structure
43+
44+ Please note that in the directory tree below, all instances of ` fetch ` ,
45+ ` process ` , and ` report ` are referring to the three phases of data gathering,
46+ processing, and report generation.
4447
4548```
4649Quantifying/
@@ -50,31 +53,31 @@ Quantifying/
5053│ │ ├── process.yml
5154│ │ ├── report.yml
5255│ │ └── static_analysis.yml
53- ├── data/ # Data storages from script runs
56+ ├── data/ # Data generated by script runs
5457│ ├── 20XXQX/
5558│ │ ├── 1-fetch/
5659│ │ ├── 2-process/
5760│ │ ├── 3-report/
5861│ │ │ └── README.md # All generated reports are displayed in the README
5962│ └── ...
6063├── dev/
61- ├── pre-automation/ # All Quantifying work prior to adding automation system
62- ├── scripts/ # Runs scripts for all phases
64+ ├── pre-automation/ # All Quantifying work prior to adding automation system
65+ ├── scripts/ # Run scripts for all phases
6366│ ├── 1-fetch/
6467│ ├── 2-process/
6568│ ├── 3-report/
6669│ └── shared.py
6770├── .cc-metadata.yml
68- ├── .flake8
71+ ├── .flake8 # Python tool configuration
6972├── .gitignore
70- ├── .pre-commit-config.yaml
73+ ├── .pre-commit-config.yaml # Static analysis configuration
7174├── LICENSE
72- ├── Pipfile # Specifies the project's dependencies and Python version
75+ ├── Pipfile # Specifies the project's dependencies and Python version
7376├── Pipfile.lock
7477├── README.md
7578├── env.example
7679├── history.md
77- ├── pyproject.toml
80+ ├── pyproject.toml # Python tools configuration
7881└── sources.md
7982```
8083
0 commit comments