Provide TL;DR for new contributors

[ClaudiaComito]

[@Mystic-Slice @shahpratham @mrfh92 @bducos I got started on issue #1051 . This is a just a draft, we'd love your input on both content and format, feel free to comment here or commit changes. Of course @AmirTouilPU @neosunhan @saisuraj27-729 @tewodros18 feel free to chime in, if you have time.]

Description

Provide quick hands-on instructions for new contributors, in preparation for GSoC23.
Still TODO:

• add FAQ
• coordinate with content in Contributing
• even better: TL;DR on README should be a list of links to Contributing sections
• add a script to test MPI environment e.g. mpirun -n 2 python test_script.py
• DOs and DON'Ts just a placeholder for now, need a more welcoming format
• ...??
• maybe add a short help regarding authetification (set up of ssh etc.)

Issue/s resolved: #1051

Changes proposed:

Type of change

• Documentation update

Memory requirements

NA

Performance

NA

Due Diligence

• All split configurations tested
• Multiple dtypes tested in relevant functions
• Documentation updated (if needed)
• Title of PR is suitable for corresponding CHANGELOG entry

Does this change modify the behaviour of other functions? If so, which?

no

[codecov]

Codecov Report

Merging #1052 (a99afe1) into main (30f218d) will decrease coverage by 0.07%.
The diff coverage is n/a.

❗ Current head a99afe1 differs from pull request most recent head 8bf92d5. Consider uploading reports for the commit 8bf92d5 to get more accurate results

@@            Coverage Diff             @@
##             main    #1052      +/-   ##
==========================================
- Coverage   91.76%   91.68%   -0.08%     
==========================================
  Files          72       65       -7     
  Lines       10352     9978     -374     
==========================================
- Hits         9499     9148     -351     
+ Misses        853      830      -23     

Flag	Coverage Δ
unit	91.68% <ø> (-0.08%)	⬇️

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

Impacted Files	Coverage Δ
heat/core/linalg/solver.py	69.00% <0.00%> (-12.51%)	⬇️
heat/core/communication.py	96.20% <0.00%> (-0.02%)	⬇️
heat/__init__.py	100.00% <0.00%> (ø)
heat/core/factories.py	100.00% <0.00%> (ø)
heat/core/_operations.py	96.04% <0.00%> (ø)
heat/sparse/__init__.py
heat/sparse/dcsr_matrix.py
heat/sparse/factories.py
heat/sparse/tests/__init__.py
heat/sparse/_operations.py
... and 2 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[ghost]

👇 Click on the image for a new way to code review

• Make big changes easier — review code in small groups of related files

• Know where to start — see the whole change at a glance

• Take a code tour — explore the change with an interactive tour

• Make comments and review — all fully sync’ed with github

  Try it now!

Legend

[shahpratham]

Hey @ClaudiaComito ,
I think we should add this in Contributing.md and should mention at start a small TL;DR and can add its link to README.

For adding test_script, we can include 1 process sending a random number to other or just "hello world" from both process

maybe add a short help regarding authetification (set up of ssh etc.)

We can maybe link to this

[ClaudiaComito]

Guys, sorry for putting on my God Hat and bypassing the review process, GSoC23 enquiries are already pouring in. Our Quick Start is now live.

It still needs improvements so I'll leave this PR draft open.

Feel free to commit any modification you think necessary. We will review and potentially merge changes every week.

[Sai-Suraj-27]

Hi, everyone. I found that a few changes can be made to our README file to make it more better and useful for first-time viewers. After seeing the readme files of Tensorflow, Numpy...etc I made some changes to make our README file look better and more useful, I created a PR with those changes, any suggestions are welcome. So, you can merge it if you find it good. Also, please tell me if you want me to make any more changes to it, Thank you.

[ClaudiaComito]

superseded by #1079 , closing