LibreShift / red-moon

Android screen filter app for night time phone use.
GNU General Public License v3.0
642 stars 80 forks source link

Add contributors guide. #249

Open HarryHeights opened 5 years ago

HarryHeights commented 5 years ago

Communities keep software projects alive. Without them, projects usually fade into obscurity when the primary developer loses interest or becomes busy in other parts of their life. That's where you come in!

After reading this statement on your readme document, I saw the need for you to have a contributors guide document. First of all, the presence of that document sends out a message to prospective collaborators that you'd like their assistance on your project. Then secondly, it'll help them through the process of contributing to your project.

smichel17 commented 4 years ago

When everything is in the README, it is simple to decide where to put information. When there is a separate contributors guide, I need to decide what goes where. Put differently, I'm not sure what should go in it besides the information already in the readme (or how much information should stay in the readme).

I would welcome a PR to add a contributors guide, even if it only has placeholders for me to fill in.