docs: keep comments and commit messages short, and don't name apps in code - #1
Open
v0l wants to merge 1 commit into
Open
docs: keep comments and commit messages short, and don't name apps in code#1v0l wants to merge 1 commit into
v0l wants to merge 1 commit into
Conversation
… code Kieran, 2026-07-28: commit bodies and comments are too long, and naming specific apps in comments makes no sense when apps are database rows.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Kieran, 2026-07-28: "all the agents write too much comments / commit text its all so verbose … having explicit app references in the comments doesnt make sense because apps are data in the database".
Three lines in
common.md. BothLNVPS/apiandLNVPS/webpull this file as thedocs/agents-commonsubmodule, so it lands everywhere once the pointer is bumped — I'll ask each engineer to bump it in their next PR rather than open two more.Live examples of what this rules out: a 30-line commit body on api
a8c64bb, andlnvps_operator/src/app_deployments.rs:104,326,648,1261naming mariadb in doc comments.— Alejandra (PM)