naming: make madt_commits and madt_stats distinct from madt_commit and madt_status #690
Labels
No labels
breaking
bug
documentation
enhancement
epic
good first issue
help wanted
refactoring
resolution/duplicate
resolution/invalid
resolution/wontfix
security
severity/critical
severity/high
severity/low
severity/medium
status/abandoned
status/blocked
status/needs-decision
status/needs-info
status/needs-verification
testing
upstream
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
sixfold-space/madtea#690
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Problem
Two pairs of madtea commands differ by one letter, and each pair does different work:
commit/madt_commitgit commitcommits/madt_commitsstatus/madt_statusstats/madt_statsA one-letter typo selects the wrong plane.
madt_commitwrites;madt_commitsonly reads. In a tool list, the pairs sit next to each other and look the same.What gh and tea do
Neither one gives a name to copy:
commit,commits, orstatscommand. gh reads commits withgh search commits.gh statusexists, but it is a dashboard of assigned issues, PRs, review requests, and mentions across repos, not working-tree status (https://cli.github.com/manual/gh_status).docs/COMPARISON.mdagrees: gh and tea are ❌ on thecommits,stats,status, andcommitrows.The naming rules that apply
docs/contributing/naming-conventions.md:62-84gives the singular name to the local git wrapper and the tea-canonical plural to the forge resource. That rule producedcommitvscommits. The same section records one exception: the forge branch resource isbranches-remote, notbranches, becausebranchvsbranches"reads as tea jargon and confuses non-tea users".commitvscommitshas the same problem.statusmirrorsgit status, and a local wrapper matches git exactly, sostatuskeeps its name.statshas no gh or tea equivalent, so rule 3 of the convention applies: pick a clear name.Candidate names
I have not picked the names yet.
commits/madt_commits:commits-remote/madt_commits_remote. This follows thebranches-remoteprecedent, so it is a second recorded exception to ADR 0016.stats/madt_stats:insights/madt_insights(the name GitHub's web UI gives to the same data), oranalytics/madt_analytics.Acceptance criteria
stats usagemoves with the rest ofstats.commitsexception next to thebranches-remoteone, and the naming-conventions.md table gains its row.internal/parity/passes on the new names.endpointSuggestionsininternal/service/api/suggestions.go,docs/COMPARISON.md, the help topics, the server instructions, and the generated reference docs use the new names.madt_commitsormadt_statsuses the new name.Source for the
insightscandidate: GitHub's docs put the contributors graph under the repository's Insights tab (https://docs.github.com/en/repositories/viewing-activity-and-data-for-your-repository/viewing-a-projects-contributors). The same tab holds Pulse, Commits, Code frequency, and Traffic (https://docs.github.com/en/repositories/viewing-activity-and-data-for-your-repository/about-repository-graphs).Correction to the body: Insights matches the contributor and commit data in
madt_stats, not all of it. The org totals and the issue time-to-close inmadt_statshave no Insights equivalent.