Skip to content
This repository has been archived by the owner on Feb 15, 2024. It is now read-only.

Add terms doc #44

Open
atc0005 opened this issue Jun 11, 2020 · 1 comment
Open

Add terms doc #44

atc0005 opened this issue Jun 11, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@atc0005
Copy link
Owner

atc0005 commented Jun 11, 2020

Goals:

  • List out common phrases/names used throughout the codebase
  • Have one location that serves as a common reference/look-up point

Ex:

  • ActiveFile vs ActiveUsersFile
  • AuditFile vs AuditLogFile
  • ActionLog vs EventLog vs ReportedUsersLog
@atc0005 atc0005 added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 11, 2020
@atc0005 atc0005 added this to the Future milestone Jun 11, 2020
@atc0005
Copy link
Owner Author

atc0005 commented Jun 11, 2020

Related:

https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker

This extension supports per-project dictionaries of terms. While not everyone uses Visual Studio Code, it is likely that other editor extensions support a similar word list; perhaps a common format can be found to provide a unified list, but if not perhaps it wouldn't be too much effort to keep ~ 2 files in sync?


EDIT: If nothing else, perhaps a common format and a small tool to regenerate multiple formats at version release time? This is probably worth its own separate issue ...

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant