search

pepkit / pephub

A web API and database for biological sample metadata
https://pephub.databio.org
BSD 2-Clause "Simplified" License
12 stars 2 forks source link

Mechanism for collecting feedback #371

Open nsheff opened 2 months ago

nsheff commented 2 months ago

I would like to add a simple "Help/Feedback" tool to collect feedback from our users.

It would be nice if there was an easy way for them to notify us if something is not working or to ask a question, right from within PEPhub, since they're logged in, we could just make it a simple web form, since it would be unlikely to be abused.

nleroy917 commented 2 months ago

I think soliciting feedback would be useful. My initial thought is: Isn't that what GitHub issue are for? However, the barrier to entry there is a bit higher since you need to know about GitHub, navigate there and open an issue. If it was embedded into the app, its easier to collect that feedback directly.

Alternatively, we could let people into the discord (getting access to only a few channels) and make the conversation synchronous...

nleroy917 commented 2 months ago

A simple form popup in the app is simple to develop and low barrier to entry. We could insert into a table in the database called feedback with the text and then a simple timestamp.

One problem is that we'd need an API endpoint for this, and obviously we need to protect that so people don't start spamming the database feedback table (with a python script)

sanghoonio commented 2 months ago

I think soliciting feedback would be useful. My initial thought is: Isn't that what GitHub issue are for? However, the barrier to entry there is a bit higher since you need to know about GitHub, navigate there and open an issue. If it was embedded into the app, its easier to collect that feedback directly.

I think you are right. Anyone who uses PEPhub for more than just browsing public PEPs will need a GitHub account. They may not know about the issues or discussions features of GitHub, maybe adding direct links to the issues and discussions tabs of our repo would help?

image

'Give Feedback' would link to https://github.com/pepkit/pephub/discussions 'Report a Bug' would link to https://github.com/pepkit/pephub/issues

This means casual visitors to PEPhub need a GitHub to provide feedback, but I think you would need to log in to encounter a potential bug in the first place.

nsheff commented 2 months ago

Ok, let's go with that. I like it.