add CONTRIBUTING.md file (and contributing guidelines, of course)

[valeriupredoi]

Description

Closes #177

This is something we should have added a bit ago - but got prompted via the JOSS paper review - and many thanks to @Zeitsperre for bringing it up in the review! I have started fleshing out the contributing guidelines, but I could use input from @bnlawrence and @davidhassell as in-house power devs, @kmuehlbauer as someone who contributed greatly but was external to the project in the beginning, and also perhaps from @bmaranville and @jjhelmus as long term, initial contributors (and initiators, for the matter) of the project. Many thanks in advance! 🍻

Before you get started

• ☝ Create an issue to discuss what you are going to do

Checklist

• This pull request has a descriptive title and labels
• This pull request has a minimal description (most was discussed in the issue, but a two-liner description is still desirable)
• Unit tests have been added (if codecov test fails)
• Any changed dependencies have been added or removed correctly (if need be)
• If you are working on the documentation, please ensure the current build passes
• All tests pass

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.83%. Comparing base (4388175) to head (9b16c2e).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #181   +/-   ##
=======================================
  Coverage   76.83%   76.83%           
=======================================
  Files          15       15           
  Lines        2936     2936           
  Branches      467      467           
=======================================
  Hits         2256     2256           
  Misses        558      558           
  Partials      122      122           

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[bmaranville]

Looks straightforward to me - and I agree with the sentiments within.

[bnlawrence]

I think this is pretty good too. I think you've got the key elements.

[kmuehlbauer]

This looks good. We can enhance this anytime in the future. Thanks @valeriupredoi

[valeriupredoi]

spiffy, many thanks @bnlawrence and @kmuehlbauer 🍻

[kmuehlbauer]

@valeriupredoi Please enable discussions in the repo-settings, since it's usage is suggested now in CONTRIBUTING.md.

[kmuehlbauer]

@valeriupredoi Please enable discussions in the repo-settings, since it's usage is suggested now in CONTRIBUTING.md.

Many thanks! Cheers and beers ;-)

[valeriupredoi]

@kmuehlbauer I believe they were enabled, just made sure they are proper now, cheers for the heads up 🍺