minegauler icon indicating copy to clipboard operation
minegauler copied to clipboard

Add CONTRIBUTING.md

Open LewisGaul opened this issue 4 years ago • 2 comments

LewisGaul avatar Jun 07 '20 20:06 LewisGaul

Hi @LewisGaul can i contribute in this issue

Krish-bhardwaj avatar Jan 11 '22 12:01 Krish-bhardwaj

Hi @LewisGaul can i contribute in this issue

You're welcome to have a go. The basic intent is that there should be a CONTRIBUTING.md file in the root of the project, which gives guidelines for anyone who would like to contribute to the project (like yourself!). It would make sense for me to fill in the details, as the owner of the project, but if you'd like to get the basics in place then I'd welcome a PR to add the file.

Note, however, that if you're looking for a coding exercise and making changes to the app itself then this might not be the issue for you, since it's just a matter of writing a text file! (I can look into addressing this issue myself if you prefer, if you think it would be helpful to you). This might be a nice simple way to make your first contribution though :)

If you do decide to have a go at this, I'd suggest the following approach:

  • Check out https://opensource.guide/starting-a-project/#writing-your-contributing-guidelines and https://theopensourceu.org/what-is-a-contribute-md/ for some advice on what to put in the file
  • Link to the new file from the README
  • Just post a comment here if you're looking for input

LewisGaul avatar Jan 11 '22 12:01 LewisGaul