search

coffee-tools / coffee

Reference implementation for a flexible core lightning plugin manager
https://docs.page/coffee-tools/coffee
9 stars 13 forks source link

Plugin Bug Reporting in Plugins #227

Open tareknaser opened 5 months ago

tareknaser commented 5 months ago

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 commented 5 months ago

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 commented 5 months ago

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 commented 5 months ago

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