What are good ways to enable a user to attach version info when seeking support?

[neruthes]

We have are hereby holding a discussion over the issue, how may a user attach version info when seeking support or reporting bugs.

Considerations and candidate solutions are expected to be addressed here.

This discussion should not block the ongoing work with "About Maskbook" page.

[Jack-Works]

• An email address to us
• A human & machine-readable version number (like v1.10.5-2 = 2 commit after 1.10.5 tag)

[septs]

@Jack-Works

➜  Maskbook git:(master) git describe --dirty
v1.10.7-115-g6251db8f

[neruthes]

In-app "mailto" URI with email body template

Pros:

• Easy to implement.
• Easy to send.
  • We assume that majority reporters have configured email sending on the desktop and mobile devices. This assumption should be fine.

Cons:

• Need extra work to link to our own issue tracking system.
  • Our issue tracking system should not directly receive bug reports; we should import certain bugs reports from "cache" to "backlog" manually.
  • It will be good to have a bot which publishes bug reports here. Will need to tell users that bug reports are public.
    • Does the need for reporting privately exist?
    • If it exists, do we need to consider it on the product level instead of leaving them on a case-by-case basis for independent reception procedures?

GitHub issue creation template URL

Pros:

• Easy to implement.
• Directly comes here (Maskbook-Talks).

Cons:

• The reporter must have an account on GitHub.
  • At the current stage (till at least 2020 Sep), majority bug reporters should be tech people, thus having a GitHub account is not difficult for the majority of reporters.
  • However, there are reasons why certain tech people deny GitHub; Microsoft ownership being one.
    • But this portion should be low enough to ignore for now.

Copy version info is an independent action which does not necessarily relate to bug reporting

Pros:

• (I cannot find one right now)

Cons:

• Having no way to require the info programmatically means having no way to get it.

[Tedko]

Let's do mailto

[neruthes]

We will reach conclusion on this topic rapidly. If there is any additional opinion to express, please be hurry.

[Tedko]

For now just use email and ship this within our 3/15 mobile release. No more discussion needed. For future version lets see the user matrix.

On Tue, Mar 10, 2020 at 00:53 Neruthes 0x5200DF38 notifications@github.com wrote:

We will reach conclusion on this topic rapidly. If there is any additional opinion to express, please be hurry.

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/DimensionDev/Maskbook-Talks/issues/26?email_source=notifications&email_token=ABTAVTLWCA3EEG6KWT6SDZLRGXWW7A5CNFSM4K7NVJW2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEOKL5IA#issuecomment-596950688, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABTAVTOLDT3UMM5GZJT3HHDRGXWW7ANCNFSM4K7NVJWQ .

[neruthes]

The majority response is mailto URI with predefined body text. I think we have a consensus now.

Further designs will work on this decision.

[Jack-Works]

We can have both of them

[neruthes]

We can have both of them

Human-readable version number will certainly be included in "About Maskbook" page.