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.

Sign up for GitHub

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

Jump to bottom

Github Setup for bug reporting & contributing #15

Closed
2 tasks done
rcoup opened this issue Oct 4, 2021 · 7 comments
Closed
2 tasks done

Github Setup for bug reporting & contributing #15

rcoup opened this issue Oct 4, 2021 · 7 comments
Labels
documentation Improvements or additions to documentation
Projects
Progress
Milestone
Initial Release

Comments

@rcoup
Copy link
Member

rcoup commented Oct 4, 2021 •
edited

  • Issue template — make sure we're getting the right info/OS/versions/logs/context/etc to help figure issues out quickly.
  • Contributing doc — how to get up and running with the plugin for development (as opposed to "install from here"), conventions, etc.
@rcoup rcoup added the documentation Improvements or additions to documentation label Oct 4, 2021
@volaya
Copy link
Contributor

volaya commented Oct 5, 2021

I added the contributing doc, taking inspiration from the corresponding one in Kart.
I have also configured the CI to produce artifacts for each commit, with a valid zip file that can be installed using the QGIS plugin manager. The version is automatically set to dev-[GIT_SHA]

About the issue tempate, I do not have permissions to edit that, but I guess the most important info will be plugin version, kart version, qgis version, and a stack trace if possible. Any suggestion on how to make it easier for the user to collect that info from the plugin?

@rcoup
Copy link
Member Author

rcoup commented Oct 5, 2021

Any suggestion on how to make it easier for the user to collect that info from the plugin?

I think easiest is probably a Plugins...Kart...About dialog showing version info we need with copy & paste-able text.

I don't know how logging is normally done in QGIS plugins, but maybe we create/truncate a plugin log file each QGIS session and then have the About dialog link to it so people can find it to attach to a bug report?

@volaya
Copy link
Contributor

volaya commented Oct 5, 2021

Ok, I will add that menu entry. That's what I have thought as well.

Logging goes to the QGIS log, where users can copy & paste easily. In case of an unhandled exception, QGIS will show a full error trace that can also be copied. That's the usual way for reporting bugs in plugins.

@volaya
Copy link
Contributor

volaya commented Oct 5, 2021

@rcoup Here is what is shown now in the About menu of the plugin:

image

In case Kart is not correctly installed and configured, a warning message is shown in the Kart details section. It also adds the current configuration of the kart folder in the plugin

@rcoup
Copy link
Member Author

rcoup commented Oct 5, 2021

Looks good to me, we can expand as we need to.

@rcoup rcoup added this to Next in Progress Oct 11, 2021
@rcoup rcoup added this to the Initial Release milestone Dec 14, 2021
@rcoup
Copy link
Member Author

rcoup commented Dec 14, 2021

@volaya can we add the Operating System name & version to the About Kart dialog? Easier for a user to copy & paste.

@volaya
Copy link
Contributor

volaya commented Dec 15, 2021

Done

@volaya volaya closed this as completed Dec 15, 2021
Progress automation moved this from Next to Done Dec 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
Progress
Done
Milestone
Initial Release
Development

No branches or pull requests
2 participants
@rcoup @volaya