drift icon indicating copy to clipboard operation
drift copied to clipboard

More noticeable demo

Open SilencerWeb opened this issue 5 years ago • 1 comments

Is your feature request related to a problem? Please describe. Right now it is too hard to find a demo in your README. The first thing that I wanted to see is a demo but instead of this I had to scroll all over the README and look for it.

Describe the solution you'd like

  1. Add a link to the content table

image 2. Add a link to the repo's description

image 3. Add a link as a heading right before "Installation"

image

Additional context The screenshots are from repo of the project "Luminous" because this problem concerns it too. You just should understand that the first thing the person who is looking for a zooming library and found your repository in the Google (not on the project's website) wants to see is a demo, not anything else. If you approve this idea I can make pull requests both in this and "Luminous" repo.

SilencerWeb avatar Mar 23 '19 03:03 SilencerWeb

Hey @SilencerWeb thanks for the suggestion. I definitely agree that the demo should be more noticeable for users new to the project and would be happy to accept a PR for this change in both our drift and luminous repos.

sherwinski avatar Apr 01 '19 22:04 sherwinski

I would like to work on this issue

PeritusDeveloper avatar Oct 04 '22 19:10 PeritusDeveloper

Hi @PeritusDeveloper, thank you so much for letting us know, I'll go ahead and assign you to this issue.

If you haven't already, I would recommend checking out our contributing guide (CONTRIBUTING.md) - there's a few potential gotchas with how we need to title and format our commits to have everything in our pipeline work together nicely.

atlawrie avatar Oct 04 '22 19:10 atlawrie

Sure I will go through the contributing guide. I was planning to add gifs to make the demo noticeable

PeritusDeveloper avatar Oct 04 '22 20:10 PeritusDeveloper

Hi @PeritusDeveloper , apologies for the confusion! The issue isn’t that the demo itself isn’t very noticeable, it’s that the link to the demo is hard to find in the context of the readme. The initial comment in the thread outlines a proposed solution, but if you have other suggestions feel free to comment your proposed changes in this thread.

atlawrie avatar Oct 04 '22 21:10 atlawrie

Considering that this is my first contribution to the project, could you kindly check that PR #671 is as expected? Thank you and have a great day!

sisco0 avatar Oct 05 '22 02:10 sisco0

Hi @sisco0, for the purpose of Octoberfest we're going to work with Peritus on this issue, since they had already expressed their interest and submitted a PR. Thank you very much for your interest though, and hopefully your other PR will serve as a good learning experience in this issue's place.

atlawrie avatar Oct 06 '22 03:10 atlawrie