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

x/build/maintner: inconsistent/not idiomatic spelling of GitHub in two identifiers #20236

Closed
2 tasks done
dmitshur opened this issue May 4, 2017 · 1 comment
Closed
2 tasks done
Labels
Builders x/build issues (builders, bots, dashboards) FrozenDueToAge
Milestone

Comments

@dmitshur
Copy link
Contributor

dmitshur commented May 4, 2017

This is a minor issue. It's also trivial to fix if a minor breaking API change is acceptable (IIRC x/build API is not yet stable, please correct if wrong). It's easier to resolve this sooner rather than later, before it has more users.

Most of the identifiers use "GitHub" or "github" (unexported version) spelling, which is correct and consistent:

  • type GitHub
  • type GitHubUser
  • type GitHubIssue
  • type GitHubLabel
  • type GitHubMilestone
  • type GitHubComment
  • type GitHubIssueEvent
  • type GitHubIssueRef

But 2 identifiers use "Github", which is neither:

  • type GithubRepoID
  • func (*Corpus) TrackGithub

They should be renamed to use "GitHub", if possible.

Rationale: https://dmitri.shuralyov.com/idiomatic-go#for-brands-or-words-with-more-than-1-capital-letter-lowercase-all-letters.

References: https://github.com/logos, https://en.wikipedia.org/wiki/GitHub.

/cc @bradfitz

@gopherbot gopherbot added this to the Unreleased milestone May 4, 2017
@gopherbot gopherbot added the Builders x/build issues (builders, bots, dashboards) label May 4, 2017
@kevinburke kevinburke self-assigned this May 7, 2017
@gopherbot
Copy link

Change https://golang.org/cl/66030 mentions this issue: maintner: rename TrackGithub to TrackGitHub

@golang golang locked and limited conversation to collaborators Sep 25, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Builders x/build issues (builders, bots, dashboards) FrozenDueToAge
Projects
None yet
Development

No branches or pull requests

3 participants