search

happinesspackets / happinesspackets

Anonymously reach out to the people that you appreciate or to whom you are thankful in your community
https://happinesspackets.io
Apache License 2.0
48 stars 12 forks source link

[design] Create "README button" to include in open source projects #40

Open jwflory opened 6 years ago

jwflory commented 6 years ago

Summary

Create a pretty "README button" that anyone can take and insert into their project README to ask people to write them a Happiness Packet

Background

I saw this implemented on the pipenv docs page first, but you can see another example in the saythanks.io README. The button does two things:

  1. Encourages someone who enjoys an open source project to say thanks to the maintainer
  2. Improves visibility and awareness of Happiness Packets by letting maintainers add a button to their README

The button becomes 2x more convenient if #39 is implemented, but #39 is not required for this to be useful.

Details

The button should follow the aesthetic design of other GitHub-style READMEs, so it would "fit in" with other buttons a project may already be using. I'm not sure if there any resources that standardize this design though.

Outcome

Project maintainers add Happiness Packets button to their READMEs, more people write Happiness Packets to awesome people, and more people learn about Happiness Packets!

mxsasha commented 6 years ago

I like it! I think we should really do #39 first though, to set the recipient automatically.

jwflory commented 6 years ago

@mxsasha From my POV, this isn't blocked by #39, since I would envision it as a button with a link. A project maintainer could always later edit the link with pre-filled fields if support is implemented. I know I'd like to add a button to a few READMEs already today, and give a specific project email to list along with it.

I filed this separate because I wasn't sure if you would need longer time to get a design asset created or to work with the project designer or not. Either way, I thought it would be a cool way to build awareness of Happiness Packets. :slightly_smiling_face: