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

Document bug reporting for unofficial packages #6855

Closed
wants to merge 1 commit into from
Closed

Document bug reporting for unofficial packages #6855

wants to merge 1 commit into from

Conversation

lengau
Copy link

@lengau lengau commented Jan 14, 2023

This attempts to redirect users filing reports for unofficial packages to those packages' issue trackers.

Spawned from the conversation at casperdcl#7 (comment)

This attempts to redirect users filing reports for unofficial packages to those packages' issue trackers.

Spawned from the conversation at casperdcl#7 (comment)
@lengau lengau requested a review from a team as a code owner January 14, 2023 02:31
@lengau lengau requested review from mislav and removed request for a team January 14, 2023 02:31
@cliAutomation cliAutomation added the external pull request originating outside of the CLI core team label Jan 14, 2023
@cliAutomation cliAutomation added this to Needs review 🤔 in The GitHub CLI Jan 14, 2023
Copy link
Contributor

@mislav mislav left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thank you for proposing these changes, but after some deliberation I am thinking that it doesn't significantly improve our docs, so I would leave these notes out for now to keep our docs and our issue templates simple.

The language used in these notices assumes that the user always knows if they were using an official package or not, but the problem is that most users don't know that. For example, someone might see our Ubuntu installation instructions and think “oh, they have an Ubuntu package!” and type apt install gh in their system, thus unwittingly obtaining an unofficial package from Snap instead of installing from our own PPA. Others see that we maintain some Linux packages and then go install gh with a package manager of their choice, which could depending on their OS and "sources" configuration result in an unofficial package being installed.

Lastly, we don't want to maintain a list of URLs to issue trackers of other projects. Ideally, the gh binary would include information about how it was built and what is the issue tracker URL, with that information being injected at build time. (Currently, only the build date is injected at build time.) This information would be printed from gh help or gh version. But as far as our online installation docs go, I would keep them as is without further fragmentation of "unofficial" vs. official versions.

@mislav mislav closed this Feb 13, 2023
The GitHub CLI automation moved this from Needs review 🤔 to Done 💤 Feb 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
external pull request originating outside of the CLI core team
Projects
No open projects
The GitHub CLI
  
Done 💤
Development

Successfully merging this pull request may close these issues.

None yet

3 participants