maplibre-native icon indicating copy to clipboard operation
maplibre-native copied to clipboard

Bug report demo projects

Open wipfli opened this issue 2 years ago • 7 comments

I have seen that some bug reports come with little information on how to reproduce the bug. I wonder if this is because there is no stackblitz or jsbin for C++ projects...

What we could do instead is offer some demo iOS and Android projects which people can take and use for crash and bug reports. Maybe we have such projects actually already. What would be great too is if the MapLibre GL Native version could easily be switched in these demo projects such that we can see when a problem arose...

wipfli avatar Jul 01 '22 15:07 wipfli

And what would also help is enabling "bug report" and "feature request" GitHub issue templates. This gives people some structure on how to phrase stuff.

wipfli avatar Jul 01 '22 15:07 wipfli

Would you make this example projects as part of this repo or in separate "example" repos? Note that for Qt we already build a minimal example as it also acts as an integration test.

ntadej avatar Jul 01 '22 15:07 ntadej

That's a good question. I don't know... Having it in a separate repo might be good for the following reasons:

  • Code base is smaller, so cloning is faster
  • Cose base is smaller, so it is easier for people to get started with the demo

wipfli avatar Jul 01 '22 16:07 wipfli

What is the Qt example?

wipfli avatar Jul 01 '22 16:07 wipfli

What is the Qt example?

https://github.com/maplibre/maplibre-gl-native/tree/main/platform/qt/app

It does not have any dedicated build setup (it builds as part of MapLibre), but honestly if one wants to make a Qt app, this is out of scope of this project.

Note that I do plan to setup some docs which should cover "How to include in my project?" question.

ntadej avatar Jul 01 '22 16:07 ntadej

Ah nice. We could also fork https://github.com/aws-samples/amazon-location-samples and use the MapLibre demo tiles there. I agree that it is out-of-scope of MapLibre GL Native to explain to people how to make a Qt app, there must be already great resources for this. But I think it would really help us a lot if contributors could share a minimal running program which reproduces a bug they see...

wipfli avatar Jul 02 '22 12:07 wipfli

A bit in the spirit of https://stackoverflow.com/help/minimal-reproducible-example...

wipfli avatar Jul 02 '22 12:07 wipfli