pupenasan / pacframework-tools

MIT License
1 stars 0 forks source link

File structure #3

Open vozemer opened 1 year ago

vozemer commented 1 year ago

The current file structure is flat, effectively none. Thus, it's hard to understand the responsibilities of each file and it leads to code duplication and excessive cognitive load.

Proposed file structure:

├─ src
├── common
│      ├── helpers
│      ├── parsers
│      ├── formatters
│      ├── writers
├── %vendor name here%
│      ├── helpers
│      ├── parsers
│      ├── formatters
│      ├── writers
├─  docs
│   ├── images
│   ├── js
│   ├── index.html
├─  node_modules

So we'll be able to differentiate documentation from code and get more sense of vendor-specific vs. shared/common code.

pupenasan commented 1 year ago

у новій версії намагався структурувати відповідно до рекомендацій. Але на деякі документи є ряд зовнішніх посилань, тому їх розташування поки залишив без змін.

vozemer commented 1 year ago

Я думаю що ми ще кілька разів будемо до структури повертатись.