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

.lumentis - balancing advanced features and sensitive data #24

Open
eugene-yaroslavtsev opened this issue Apr 11, 2024 · 0 comments
Open

Comments

@eugene-yaroslavtsev
Copy link
Contributor

eugene-yaroslavtsev commented Apr 11, 2024

Problem

The .lumentis folder contains metadata necessary for advanced features like diff mode, but may also include sensitive transcript data that should not be committed.

Concerns

  • Diff mode and other advanced features are must-haves
  • Transcript data can be highly sensitive and should be protected
  • The wizard is already lengthy, so adding more questions should be avoided

Tradeoffs

  • committing full .lumentis data enables advanced features but risks exposing sensitive info
  • excluding .lumentis entirely protects sensitive data but loses out on advanced features
  • splitting .lumentis balances features and protection but requires careful implementation

Solution

We will split out sensitive parts of .lumentis folder and only commit the rest:

  1. move input data out of .lumentis/wizard.json - .lumentis/sensitive-inputs/raw-data
  2. move "questions for user to answer" data out as well - .lumentis/sensitive-inputs/clarifying-questions.md
  3. add "no extra fields" zod validator for .lumentis/wizard.json to ensure the sensitive inputs can't accidentally end up in there
  4. maybe add some docs (would be cool if there was some cool to do that)

Misc

Based on discussion in this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant