Skip to content

Commit 2fabfd9

Browse files
authored
docs: add database indexes under performance in contributing guide (hashicorp#1881)
1 parent de96cac commit 2fabfd9

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

CONTRIBUTING.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -208,4 +208,16 @@ Or all of the test can be run with a single target:
208208
$ make test-all
209209
```
210210

211-
## [Adding additional field to an existing API (or new API)](internal/adding-a-new-field-readme.md)
211+
## Performance
212+
### Database Indexes
213+
214+
Most of the indexes in the database are for enforcing data constraints.
215+
We have not added indexes for improving performance because we do not have a way
216+
to measure and test these types of indexes.
217+
We want a way to test and verify that indexes added to improve performance are actually being used by the system.
218+
And we want these same tests to fail when an index stops being used as we evolve the system.
219+
This is on our roadmap but we have not started work on it yet.
220+
221+
## Additional docs
222+
223+
* [Adding fields to the API](internal/adding-a-new-field-readme.md)

0 commit comments

Comments
 (0)