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

Plugin Bug Reporting in Plugins #227

Open
tareknaser opened this issue Jan 31, 2024 · 3 comments
Open

Plugin Bug Reporting in Plugins #227

tareknaser opened this issue Jan 31, 2024 · 3 comments
Labels
💭 - brainstorming feature idea and related discussion 🔥 - experimental Experimental phase feature request

Comments

@tareknaser
Copy link
Collaborator

Description:

We currently lack a simple way for users to report bugs in plugins.

Suggested Implementation:

  1. Manifest Update: Add a new field in the plugin manifest for the developer's email address for bug reporting.
  2. User Command: Introduce a new command (e.g., coffee report <plugin> <issue_faced>) for users to report plugin issues briefly.

Similar Cases in Other Projects:

Brew:

  • In Brew, the brew info <cask> command provides various details about a package, including the developer's email address. This is not explicitly designed for bug reporting but this kind of information could be used as well to report issues.
@vincenzopalazzo
Copy link
Contributor

we should look also at the example command that is git bugreport but idk how we can opens issue on github without using the github API

@tareknaser
Copy link
Collaborator Author

git bugreport is used to file a bug report with git itself.
It gives the user a template with useful information (eg. system information and git version), and then saves the file and asks the user to send it to their mailing list.

we can take a similar approach. when users run coffee report, they'll be prompted to fill out a template with details about the issue. Then, we'll suggest sending this report to the maintainer's email address.

@vincenzopalazzo
Copy link
Contributor

we can take a similar approach. when users run coffee report, they'll be prompted to fill out a template with details about the issue. Then, we'll suggest sending this report to the maintainer's email address.

This is what I was thinking, we should just implement the maintainer info inside the coffee manifest

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💭 - brainstorming feature idea and related discussion 🔥 - experimental Experimental phase feature request
Projects
None yet
Development

No branches or pull requests

2 participants