Added readme for running tests locally

[VukW]

Proposed Changes

• Added readme that explains additional steps, required for running tests locally

Checklist

• CONTRIBUTING guide has been followed.
• PR is based on the current GaNDLF master .
• Non-breaking change (does not break existing functionality): provide as many details as possible for any breaking change.
• Function/class source code documentation added/updated (ensure typing is used to provide type hints, including and not limited to using Optional if a variable has a pre-defined value).
• Code has been blacked for style consistency and linting.
• If applicable, version information has been updated in GANDLF/version.py.
• If adding a git submodule, add to list of exceptions for black styling in pyproject.toml file.
• Usage documentation has been updated, if appropriate.
• Tests added or modified to cover the changes; if coverage is reduced, please give explanation.
• If customized dependency installation is required (i.e., a separate pip install step is needed for PR to be functional), please ensure it is reflected in all the files that control the CI, namely: python-test.yml, and all docker files [1,2,3].

[github-actions]

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

[codecov]

Codecov Report

Attention: Patch coverage is 75.00000% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 95.03%. Comparing base (702194a) to head (3e28c63).
Report is 1 commits behind head on master.

Files	Patch %	Lines
testing/test_full.py	75.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #827      +/-   ##
==========================================
- Coverage   95.04%   95.03%   -0.02%     
==========================================
  Files         120      120              
  Lines        8268     8270       +2     
==========================================
+ Hits         7858     7859       +1     
- Misses        410      411       +1     

Flag	Coverage Δ
unittests	95.03% <75.00%> (-0.02%)	⬇️

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.

[sarthakpati]

Thanks!

Can you put these instructions in this document [ref] so that it gets rendered in HTML? And refer to this link in this README.

[VukW]

@sarthakpati Thanks for the link, didn't find when was searching!
Moved "readme" to main doc as you proposed.

[VukW]

@sarthakpati

The only check that is failing right now is codecov - because of reduced coverage. However, because my changes are in the test itself, it should be ok.
Therefore, I believe, PR is ready. May I ask you to review it again. please?

[sarthakpati]

Requesting minor change. Should be good to go after this.

[sarthakpati]

LGTM