Utopian Contribution: Added Descriptive Opening to Github

Words
234
Reading
2 min
Listen
Play
9y

Currently, the README.md on Utopian's Github Page is bland:

image.png

If you were an open-source contributor on Github and you found this, does it seem inviting for you to contribute? Probably not! I've added many changes to make it much more inviting for potential contributors:

image.png

My Changes

Here's how it will look after my Pull Request is applied:


image.png
image.png
image.png

More Descriptive, Inviting

I've changed the opening statement to be more focused on what Utopian does, and I've added beautiful screenshots to entice people into contributing!

Additionally, I've specified that we use STEEM to reward users in cryptocurrency, to entice the crypto community to check it out as well.

Local Installation Directions

Currently, it's hard for people to contribute because they don't know how to run Utopian locally on their computer. I've fixed this by adding local installation directions right into the file.

These step-by-step directions let you run Utopian.io right from your computer and test out any changes you want to make!

Impact of My Changes

The README.md is the "homepage" of your project on Github. It's the first thing potential contributors see when they view your project. That's why it's so important to make it inviting, descriptive, and clear so that contributors can do as much as they can to help!


Thanks for reading,
— mooncryption@mooncryption

image sources: Github
proof of work: pull request, commits



Posted on Utopian.io - Rewarding Open Source Contributors

Utopian Contribution: Added Descriptive Opening to Github | Ecency