Skip to content

Commit fab3d2a

Browse files
docs: updated tree structure for contributing.md
1 parent 1b0d696 commit fab3d2a

File tree

1 file changed

+46
-7
lines changed

1 file changed

+46
-7
lines changed

contributing.md

Lines changed: 46 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -68,14 +68,40 @@ rate-limit-postgresql
6868
│ ├── tsconfig.cjs.json
6969
│ └── tsconfig.esm.json
7070
├── contributing.md
71+
├── db
72+
│ ├── cli
73+
│ │ ├── apply_all_migrations.sh
74+
│ │ ├── init_db.sh
75+
│ │ └── run_tests.sh
76+
│ ├── linting
77+
│ │ ├── lint.sh
78+
│ │ └── requirements.txt
79+
│ └── tests
80+
│ ├── performance
81+
│ │ ├── aggregated_ip.test.sql
82+
│ │ └── individual_ip.test.sql
83+
│ └── unit
84+
│ ├── agg_decrement.test.sql
85+
│ ├── agg_increment.test.sql
86+
│ ├── agg_reset_key.test.sql
87+
│ ├── agg_reset_session.test.sql
88+
│ ├── ind_decrement.test.sql
89+
│ ├── ind_increment.test.sql
90+
│ ├── ind_reset_key.test.sql
91+
│ ├── ind_reset_session.test.sql
92+
│ ├── session_reset.test.sql
93+
│ └── session_select.test.sql
7194
├── license.md
7295
├── package.json
7396
├── package-lock.json
7497
├── readme.md
7598
├── source
7699
│ ├── index.ts
77100
│ ├── migrations
78-
│ │ └── 1-init.sql
101+
│ │ ├── 1-init.sql
102+
│ │ ├── 2-add-db-functions-agg.sql
103+
│ │ ├── 3-add-db-functions-ind.sql
104+
│ │ └── 4-add-db-functions-sessions.sql
79105
│ ├── models
80106
│ │ └── session.ts
81107
│ ├── stores
@@ -92,11 +118,12 @@ rate-limit-postgresql
92118
│ │ └── store_individual_ip.spec.ts
93119
│ └── util
94120
│ └── session_handler.spec.ts
95-
└── third_party_licenses
96-
├── dev_detailed.json
97-
├── dev_summary.txt
98-
├── production_detailed.json
99-
└── production_summary.txt
121+
├── third_party_licenses
122+
│ ├── dev_detailed.json
123+
│ ├── dev_summary.txt
124+
│ ├── production_detailed.json
125+
│ └── production_summary.txt
126+
└── tsconfig.json
100127
```
101128

102129
> The content of `third_party_licenses` is auto-generated.
@@ -120,10 +147,22 @@ applied, etc.
120147

121148
- `tsconfig.*.json`: The Typescript configuration files for this project.
122149

150+
#### `db/`
151+
152+
- `db/cli/*.sh`: Bash scripts used by the database part of the CI pipeline
153+
- `db/linting/lint.sh`: Bash scripts used for linting SQL files as part of the
154+
database CI pipeline
155+
- `db/linting/.sqlfluff`: Configuration file for the `sqlfluff` linter
156+
- `db/linting/requirements.txt`: Python dependencies for the `sqlfluff` linter
157+
- `db/tests/performance/*.test.sql`: Performance tests for the stored procedures
158+
(using `pg_tap`)
159+
- `db/cli/unit/.test.sql`: Unit tests for the stored procedures (using `pg_tap`)
160+
123161
#### `source/`
124162

125163
- `source/migrations/*.sql`: Database migrations that are applied by
126-
`postgres-migrations` `source/models/*.ts`: Relevant types (e.g., Session)
164+
`postgres-migrations`
165+
- `source/models/*.ts`: Relevant types (e.g., Session)
127166
- `source/util/*.ts`: The centralized business logic for handling session
128167
validity (`session_handler.ts`) and migration handling
129168
(`migration_handler.ts`)

0 commit comments

Comments
 (0)