Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Separate dict.txt from clever-rockies to distinguish terminology from method #23

Open
dax-westerman opened this issue Jul 2, 2024 · 0 comments
Labels
suggestion An issue that suggests change to workflow to method, not necessarily to implement.
Milestone

Comments

@dax-westerman
Copy link
Collaborator

The following is an idea I wanted to get down as a potential process improvement. It's also an example of what could be included as part of a "Project" to bucket ideas.


Currently the dict.txt file containing the terminology is strongly bound to the clever tool. It might make sense to separate the dict.txt file into its own repository to gain the following benefits.

  • Versioning of terminology independent of code changes to CLEVER
  • Code to update/validate dict.txt contained as distinct from CLEVER (separation of concerns, method versus validation)
  • Prevents accidental inclusion of code changes, since PR review may focus solely on terminology (reduction of human error)

The "main" version of the dictionary could be included as a git submodule (i.e., reference to a git repo within a git repo), such that CLEVER will maintain a reference to the "production" version of the terminology.

@dax-westerman dax-westerman added the suggestion An issue that suggests change to workflow to method, not necessarily to implement. label Jul 2, 2024
@dax-westerman dax-westerman added this to the backlog milestone Jul 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
suggestion An issue that suggests change to workflow to method, not necessarily to implement.
Projects
None yet
Development

No branches or pull requests

1 participant