Skip to content

AGENTS.md

Latest commit

 

History

History
9 lines (9 loc) · 832 Bytes

AGENTS.md

File metadata and controls

9 lines (9 loc) · 832 Bytes
  • <VERSION>/AGENTS.md should be generated based on fastrepl/hyprnote's git tag.
    • For example, v1.0.1/* should be based on https://github.com/fastrepl/hyprnote/tree/desktop_v1.0.1.
    • Each AGENTS.md should contain clear descriptions/examples of how data on user devices looks.
    • Each AGENTS.md should never reference main or migrations.
    • Describe how data looks in detail. Never make mistakes on format or filename.
    • Note that hyprnote/crates/db-user is irrelevant. Focus on hyprnote/apps/desktop/src/store/tinybase.
  • <VERSION>/<NAME> should be a folder that can be used for the CONTENT_BASE env variable.
    • For example, CONTENT_BASE="$REPO/v1.0.1/simple" /Applications/Hyprnote\ Staging.app/Contents/MacOS/hyprnote-staging
    • This ensures new versions work properly with existing user data.