Contributor's guide created for Knacksteem.

in #utopian-io5 years ago (edited)

Repository

https://github.com/knacksteem/knacksteem.org

Linked Task Request

There was no task request for this contribution. However, after stating my intention to render my copywriting services to the project via an issue on Github, the project owner has since then relinquished almost all writing tasks to me.

Overview

Open source projects are mostly characterized by collaborative developments. Development, in this case, doesn't actually mean writing a code only. It means other members can contribute to various areas of the project which I generalize as "Development".
This is a great way to further advance a project. However, not every sort of contributions is welcomed by project owners. This is why a contributor's guide which is often a written document is essential for every open source project. This document informs a prospective contributor to what kind of contributions are accepted and how to go about them.

Actual content

The contributor's guide I created was split into different points to make it easy for contributors to understand.
The first part of the document was the introduction. This was to entreat them to contribute to the project. Other points in the document include;

  • Submitting feature requests
  • Bug & Crash reports
  • Code contribution
  • Documentation
  • Creating pull requests.

Some sub-points were also contained in the document.

Read the full Contributor's guide

Additional information

The creation of this document, like other documents I've created for this project was a collaborative effort between me and the project owner. The collaboration was done on Hackmd text editor.
After content was created on Hackmd, I copied it over to Github and created a pull request. The document has been merged by the project owner.

Link to Hackmd doc
Link to Merged pull request

GitHub Account

https://github.com/HarryHeights

Sort:  

Thank you for your contribution. You did a very good and detailed job here. To further improve your work, please consider proofreading it with special attention on consistency and punctuation.

Your contribution has been evaluated according to Utopian policies and guidelines, as well as a predefined set of questions pertaining to the category.

To view those questions and the relevant answers related to your post, click here.


Need help? Write a ticket on https://support.utopian.io/.
Chat with us on Discord.
[utopian-moderator]

Thank you for your review, @jmromero! Keep up the good work!

Hi, @harry-heightz!

You just got a 6.26% upvote from SteemPlus!
To get higher upvotes, earn more SteemPlus Points (SPP). On your Steemit wallet, check your SPP balance and click on "How to earn SPP?" to find out all the ways to earn.
If you're not using SteemPlus yet, please check our last posts in here to see the many ways in which SteemPlus can improve your Steem experience on Steemit and Busy.

Congratulations! Your post has been selected as a daily Steemit truffle! It is listed on rank 14 of all contributions awarded today. You can find the TOP DAILY TRUFFLE PICKS HERE.

I upvoted your contribution because to my mind your post is at least 2 SBD worth and should receive 71 votes. It's now up to the lovely Steemit community to make this come true.

I am TrufflePig, an Artificial Intelligence Bot that helps minnows and content curators using Machine Learning. If you are curious how I select content, you can find an explanation here!

Have a nice day and sincerely yours,
trufflepig
TrufflePig

Hi @harry-heightz!

Your post was upvoted by @steem-ua, new Steem dApp, using UserAuthority for algorithmic post curation!
Your post is eligible for our upvote, thanks to our collaboration with @utopian-io!
Feel free to join our @steem-ua Discord server

Hey, @harry-heightz!

Thanks for contributing on Utopian.
We’re already looking forward to your next contribution!

Get higher incentives and support Utopian.io!
Simply set @utopian.pay as a 5% (or higher) payout beneficiary on your contribution post (via SteemPlus or Steeditor).

Want to chat? Join us on Discord https://discord.gg/h52nFrV.

Vote for Utopian Witness!


Congratulations @harry-heightz!
You raised your level and are now a Minnow!

Do not miss the last post from @steemitboard:

Christmas Challenge - The party continues
Christmas Challenge - Send a gift to to your friends

Support SteemitBoard's project! Vote for its witness and get one more award!

Coin Marketplace

STEEM 0.28
TRX 0.12
JST 0.032
BTC 66416.78
ETH 3082.93
USDT 1.00
SBD 3.68