Skip to content
Snippets Groups Projects
Verified Commit 3edfc569 authored by Eliot Berriot's avatar Eliot Berriot
Browse files

Added report bug guide

parent 92acf8d0
No related branches found
No related tags found
No related merge requests found
Pipeline #3800 passed
public/assets/guides/report-a-bug/full-example.png

130 B

public/assets/guides/report-a-bug/log.png

130 B

public/assets/guides/report-a-bug/template.png

130 B

......@@ -353,8 +353,96 @@ export function getTasks (v) {
{
name: v.$pgettext('Task name', "Report a bug"),
icon: "bug",
slug: 'report-a-bug',
duration: 15,
summary: v.$pgettext("Task summary", "Report typos, display issues, or other unexpected bebaviour, or fix it yourself."),
steps: [
{
title: v.$pgettext("Guide step title", 'Search for similar bugs'),
content: [
v.$pgettext("Guide step content", 'A quick search can yield similar bug and avoid opening duplicate. Take a minute or two to search our issue tracker for recent bug reports that could match yours.'),
v.$pgettext("Guide step content", "If you find a similar bug report, you can comment on this one instead of creating a new one."),
v.$pgettext("Guide step content", "If you are unsure about submitting a bug report or have other general tech questions, you can also start a thread in our Loomio support group, or ask us on our Fediverse account."),
],
links: [
{
icon: 'gitlab',
text: v.$pgettext("Text for link in guide step", 'Browse existing bugs'),
url: 'https://dev.funkwhale.audio/funkwhale/funkwhale/issues?label_name%5B%5D=Type%3A+Bug',
},
{
icon: 'comment',
text: v.$pgettext("Text for link in guide step", 'Start a thread on our support forum'),
url: 'https://governance.funkwhale.audio/g/246YOJ1m/funkwhale-support',
},
{
icon: 'mastodon',
text: v.$pgettext("Text for link in guide step", 'Get in touch on the Fediverse'),
url: 'https://mastodon.eliotberriot.com/@funkwhale',
}
]
},
{
title: v.$pgettext("Guide step title", 'Create your Contributor Account'),
content: [v.$pgettext("Guide step content", 'This account is needed to submit your bug report or comments.'),],
links: [
{
icon: 'gitlab',
text: v.$pgettext("Text for link in guide step", 'Create your GitLab account'),
to: {name: 'guide', params: {slug: 'gitlab-account', locale: v.$language.current}},
}
]
},
{
title: v.$pgettext("Guide step title", 'Write your bug report'),
content: [
v.$pgettext("Guide step content", 'Select "Bug" in the issue template dropdown, then fill the title and content for your bug report.'),
v.$pgettext("Guide step content", 'Try to be as precise and specific as possible: the other contributors that will read your report may not know things that are obvious to you.'),
v.$pgettext("Guide step content", "We know writing an actionable bug report is hard. Do your best and give as much context as possible, but don't worry: other contributors will reach out to you if they need more details."),
],
recommendations: [
v.$pgettext("Advice content / recommendations", "Explain what you were trying to do"),
v.$pgettext("Advice content / recommendations", "Explain what you expected to happen"),
v.$pgettext("Advice content / recommendations", "Explain what actually happened"),
v.$pgettext("Advice content / recommendations", "Include logs, error messages, screenshots and information about your system (web browser, operating system…), if applicable"),
v.$pgettext("Advice content / recommendations", "Include the version number of the Funkwhale server on which the issue happens"),
],
avoid: [
v.$pgettext("Advice content / avoid", 'Use vague language such as "this is not working"'),
],
links: [
{
icon: 'pencil',
text: v.$pgettext("Text for link in guide step", 'Write your bug report'),
url: "https://dev.funkwhale.audio/funkwhale/funkwhale/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=",
}
],
media: [
{
type: 'image',
url: '/assets/guides/report-a-bug/template.png',
caption: v.$pgettext("Task image caption", 'Choose "bug" in the issue template drowdown')
},
{
type: 'image',
url: '/assets/guides/report-a-bug/log.png',
caption: v.$pgettext("Task image caption", 'Put logs between three ` (backticks)')
},
{
type: 'image',
url: '/assets/guides/report-a-bug/full-example.png',
caption: v.$pgettext("Task image caption", "A complete exemple of a bug report")
},
]
},
{
title: v.$pgettext("Guide step title", 'Review and submit your report'),
content: [
v.$pgettext("Guide step content", 'Read your report one last time, then click on the "Submit" button.'),
v.$pgettext("Guide step content", 'A contributor will have a look at it within the next days!'),
],
}
]
},
{
name: v.$pgettext('Task name', "Review the documentation"),
......
......@@ -17,6 +17,7 @@ module.exports = {
'/guides/loomio-account',
'/guides/translate',
'/guides/gitlab-account',
'/guides/report-a-bug',
];
let finalRoutes = [];
baseRoutes.forEach(p => {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment