Create CONTRIBUTING.md

[blakeschafer]

Creating a resource file for any developer who wants to contribute to this open-source project. Adding more details than what was already provided, giving a detailed walkthrough for newcomers on how to make changes in the code.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.43%. Comparing base (4133694) to head (3b44a18).
Report is 2 commits behind head on master.

❗ Current head 3b44a18 differs from pull request most recent head 9523f1d

Please upload reports for the commit 9523f1d to get more accurate results.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #943   +/-   ##
=======================================
  Coverage   56.43%   56.43%           
=======================================
  Files         196      196           
  Lines       15601    15601           
  Branches      558      558           
=======================================
  Hits         8804     8804           
  Misses       6543     6543           
  Partials      254      254           

Flag	Coverage Δ
api	24.94% <ø> (ø)
ui	68.82% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jordy2254]

@blakeschafer I've already got a draft somewhere on my machine there's a discussion here about how we want the contribution flow to look like in the future. However, saying that I will read the contributed doc when I have time and maybe we can use it for the interim. Thanks for your contribution.

[kkovaletp]

@blakeschafer, thank you for creating this document!
I think that this is a good start for a discussion. I hope that top contributors will live their feedback here, so we could build the optimal contribution guide for the project.

BTW, it would be great to put a link to this file in the Readme with some short description.
Also, it might be useful to mention our Discord somewhere in the document, so that contributors know that we have it and are open to talk

[kkovaletp]

I'd like to add that in case a contributor would like to pick some existing issue up for development, it makes sense to choose from issues with the project assigned (on the right side of the conversation thread) - this means that it was reviewed by maintainer(s) and confirmed to be useful for the project

[kkovaletp]

At the point, where the doc tells about the review of the existing issues, it would be useful to mention that if a contributor sees an issue with useful from his\her PoV feature proposal or a bug, he\she is struggling with, it would be a helpful contribution to like the 1st post of that issue in the conversation tab (the issue description) - in this way, maintainers could know which issues should take the priority.
Of course, if the contributor can also add a comment with some useful info, which might be missing in the issue's thread, that would help as well.

[blakeschafer]

Adding a section in the README that links to this document is a great idea! And also, yes I think there should be a link to the discord in the contributing document. Thanks all for the feedback.

[kkovaletp]

As there was no activity (new commits) after the feedback was provided, I'd jump into and prepare some commits to implement the ideas from the feedback.
@blakeschafer, I hope that you don't mind) Let me know if you'd prefer to cover it by yourself and going to provide updates soon - then I'll step back and let you finish the job)

[kkovaletp]

I've already got a draft somewhere on my machine

@jordy2254, can you please share the draft, so I can use it as a source while preparing this PR?
I'll read the comments here and the discussion #934 to refresh my understanding and the ideas proposed

[kkovaletp]

@jordy2254, I've committed the changes to address the feedback here and in the discussion #934, as well as merged your template from that discussion.
Please review this PR and let me know whether we need to add\change\remove something, or if we're good to go with it as our 1st version of the guide, improving it later according to some future changes in our processes (if any).