enhance contributing experience

[egouden]

• update guide
• update requirements

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[egouden]

There are some files not deleted after notebook tests. @kmuehlbauer Is there a quick fix?

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.50%. Comparing base (727434c) to head (2a438d4).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #315   +/-   ##
=======================================
  Coverage   93.50%   93.50%           
=======================================
  Files          27       27           
  Lines        5587     5587           
=======================================
  Hits         5224     5224           
  Misses        363      363           

Flag	Coverage Δ
notebooktests	0.00% <ø> (ø)
unittests	93.50% <ø> (ø)

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.

🚀 New features to boost your workflow:

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

[kmuehlbauer]

There are some files not deleted after notebook tests. @kmuehlbauer Is there a quick fix?

Need to look this up. We might be able to get away with this, if we run the tests in a dedicated test folder, which will be cleared afterwards.

[kmuehlbauer]

Looks good, but will require additional maintenance. We should take that path, it will make life easier for users new to the field.

Only one question regarding pre-commit.

[kmuehlbauer]

Do we need to tell the user to do pre-commit install once before running?

[egouden]

I would let the developer decides.

[kmuehlbauer]

Then maybe mentioning that in the paragraph would make sense.

[egouden]

The guide should be concise. Let's recommend pre-commit install by default !

[egouden]

There are some files not deleted after notebook tests. @kmuehlbauer Is there a quick fix?

Need to look this up. We might be able to get away with this, if we run the tests in a dedicated test folder, which will be cleared afterwards.

I think this fix should be integrated in the PR.

[kmuehlbauer]

There are some files not deleted after notebook tests. @kmuehlbauer Is there a quick fix?

Need to look this up. We might be able to get away with this, if we run the tests in a dedicated test folder, which will be cleared afterwards.

I think this fix should be integrated in the PR.

See #316 for a fix.

[kmuehlbauer]

@egouden Please add an entry to history.md. Thanks!