FunkyDevStuff/FunkyBot

add a CONTRIBUTING.md

Chovin opened this issue · 3 comments

just like the readme (#1) is the front page for the user, the CONTRIBUTING.md almost acts like the front page for potential contributors (the readme is still the first file they'll see, so maybe link the CONTRIBUTING.md in the readme 😉 ).

A README gets you familiar with the project, how to use it, and how to install it.
A CONTRIBUTING.md gets contributors familiar with what contributing to the project looks like, how to contribute to it, and how they can quickly get started contributing.

It sets guidelines to help streamline the contributing process and provides a clear path that contributors can take to get started working with you to add to your project.

If we're would like to make it as simple and rewarding as can be for people to contribute, especially during Hacktoberfest, we might wanna make this a lite intro on how to get set up and connected to github and/or repl.it to start :)

If we give them an avenue to test and play around with their code before they contribute it, that'll take pressure and fear off them too! we can perhaps link them to or explain how to set up a Discord bot account as well as how to get the bot running on their own personal computer or repl.it

a tiny section in here with a code of conduct may also help set the standard for interactions on the project and also make it more comfortable for ppl to jump in because they know how they can expect to be treated

I'll add the CONTRIBUTING.md file