CSCfi / CSCfi/rems

Consider renaming xxxdata to just data or data to xxxdata

Open
#2,725 0 comments 0 reactions 0 assignees View on GitHub
Documentation Investigate Technical Debt
Dominant language
Clojure
Stars
66
Forks
28
Avg merge
7d 4h
Merged PRs (30d)
2

Description

We have some tables with JSON column named `xxxdata` with `xxx` being the name of the concept. Some use just `data`. We should consider renaming `xxxdata` to just `data` or `data` to `xxxdata`.

One reason to prefer `xxxdata` is that if you join two tables you don't need to always rename the data columns because they have distinct names.

This change would likely not show in the API so would not break compatibility.

- [ ] document convention into ADR with some extra details about our JSON usage
- [ ] migration to do the rename

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.