Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
43 lines (25 sloc) 4.96 KB

TurtleCoin Community Projects

This document will explain what we mean when we say something is a 'TurtleCoin Community Project'

NOTE: If you're taking the time to read this document, I already like you, because you saw the word "Community" and you had to click it. Please say hello in the chat when you make an account, we'd love to meet you! chat.turtlecoin.lol 😺

What does 'Community Project' mean?

When we mark a repository as a "Community Project", it signifies that this is a project created and maintained by a TurtleCoin community member. Usually, it is a volunteer effort of one or more community members. There might be periods where the developers of a Community Project get busy during finals in school or have to finish up a large deal at the office, and updates might not come out as often as a full-time dev team would produce. Usually, this isn't the case, and these projects become a labor of love, so we hope this document shows you how to submit new feature requests for your favorite projects, and maybe even fix a bug or two!

How to contribute to a project you like

You might see a project you like that needs a better readme, or has spelling mistakes in the directions, and maybe if you're feeling generous you'd like to see it fixed, great! We make this really easy on all of our projects. For those of you not familiar with GitHub, you can click the little pencil on the document you want to submit a correction for, and it will create a copy for you to edit and then submit as a "pull-request". Sounds scary! This is really just you seeing an error in a book, copying the page and adding your corrections to it, and then sending it back to the publisher.

image (In this image, if you wanted to complete the empty README file with directions or a guide, you could click the pencil icon on the right, and the interface walks you through submitting your changes as a pull request!)

TIP: Some 'contributors' who submit corrections, and some 'developers' who submit code patches will notice that their username in the community discord changes color... and mysterious abilities may appear... This is normal :) Shhhh!

How to report a bug

This is probably one of the most important things a person can do to help us. When people come to us and say, "here are my skills, how can I help?" it makes it really easy for us to point at the bugs that you've submitted and say "hey, so-and-so pointed out this mistake in this program, can you fix that?" and usually they take care of it right away. The first step in fixing something that's broken is saying something! You can submit a bug report by clicking the button at the top of the project called ISSUES and then create a new issue.

image TIP: The best issues say more than "it's broken.". They say: what operating system, what version of the program broke, what you were doing when it broke, including a screenshot if possible of the error you see or copy and paste the log files. The more information you include, the better your issue will be able to be addressed, and we are so thankful for your time writing them.

How to get help

If you've submitted an issue, and you don't quite know how to fix it on your own, and you just need someone to help you, we've got a few channels to help with that in our chat. chat.turtlecoin.lol

  1. For general help, try #help
  2. For mining help, try #mining
  3. For help with your program you're developing, try #dev_general
  4. For your cool logo, marketing plan, try #dev_marketing

TIP: Some people will notice that when they spend time helping in these channels that a robot may drop by and fill their pockets with some shells. We want you to spend time helping people and doing nerd stuff to help the project, so it only makes sense that it rains the most in these rooms :)

Explanation of risk

There is always a risk that the person running the project you're using has embedded super secret nuclear missile plans that they hacked out of a Russian data center, but odds of this are slim, and it's never happened. We'd be stupid to say there isn't a risk that someone contributing to a community project, through no fault of their own, creates a bug that corrupts your wallet file (backup your keys!) or otherwise causes things to mess up on your system. However unlikely this is to happen, we want to error on the side of responsibility and advise you of the potential for mistakes like this, and we ask that you please back up your spend key, view key, and mnemonic seed somewhere very safe just in case we mess up the nuclear-blueprint-hiding-algorithm and blow up your router in the process. Our keyloggers are top-notch.

Thanks for reading this, if you got down this far, please say something in the chat to be showered with emojis.