Skip to content

comment fields create multiple-source-of-truth and churn #43

Open

Description

@seanmakesgames

problem

any content that could be added into the 'comment' field at this time would be less accurate than our source control git blame and would get stale very quickly. It's an easy place to introduce drag and increase maintenance costs.

context

We should be programmatically enforcing no comment field.

Originally posted by @seanmakesgames in #30 (comment)

Activity

  1. kaj-se commented on Feb 18, 2026

    @kaj-se
    Contributor

    @hmdunce and I could create a script for that. It would check whether the field is set and remove it if necessary.

    But how about the of generating the information for the Comment tags of the glyph structure based on the information in the repo and then adding it to the tags? The update process would run automatically when a merge with the repo takes place.

  2. seanmakesgames commented on Feb 19, 2026

    @seanmakesgames
    MemberAuthor

    @hmdunce and I could create a script for that. It would check whether the field is set and remove it if necessary.

    But how about the of generating the information for the Comment tags of the glyph structure based on the information in the repo and then adding it to the tags? The update process would run automatically when a merge with the repo takes place.

    #30 (comment)

    Look up 'single source of truth' for more info on what this is about.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions