Docs/unify contrib docs

[tab1tha]

What do these changes do?

Edit onboarding documentation to

• emphasize the need for npm as a pre-requisite to run tests,
• make the git clone link explicit like the rest of the commands,
• point to GitHub docs if user isn't familiar yet,
• inform macOS users about the possible need for graphviz if make doc doesn't work.

It also goes ahead to unify CONTRIBUTING.rst in root and docs/contributing.rst such that there is now one source of truth. The preliminary documentation is housed in the github-rendered outward-facing CONTRIBUTING.rst and the extended documentation is housed in docs/contributing.rst which is rendered on readthedocs.

The changes in this pull requests remove the previous duplication of preliminary documentation such that further changes to it will be done in one place (CONTRIBUTING.rst) and imported to the other locations as needed.

Are there changes in behavior for the user?

None

Is it a substantial burden for the maintainers to support this?

None. This makes future maintenance easier.

Related issue number

Checklist

• [x] I think the code is well written
• [ ] Unit tests for the changes exist
• [x] Documentation reflects the changes
• [x] If you provide code modification, please add yourself to CONTRIBUTORS.txt
  • The format is <Name> <Surname>.
  • Please keep alphabetical order, the file is sorted by names.
• [ ] Add a new news fragment into the CHANGES/ folder

  • name it <issue_or_pr_num>.<type>.rst (e.g. 588.bugfix.rst)

  • if you don't have an issue number, change it to the pull request number after creating the PR

    • .bugfix: A bug fix for something the maintainers deemed an improper undesired behavior that got corrected to match pre-agreed expectations.
    • .feature: A new behavior, public APIs. That sort of stuff.
    • .deprecation: A declaration of future API removals and breaking changes in behavior.
    • .breaking: When something public is removed in a breaking way. Could be deprecated in an earlier release.
    • .doc: Notable updates to the documentation structure or build process.
    • .packaging: Notes for downstreams about unobvious side effects and tooling. Changes in the test invocation considerations and runtime assumptions.
    • .contrib: Stuff that affects the contributor experience. e.g. Running tests, building the docs, setting up the development environment.
    • .misc: Changes that are hard to assign to any of the above categories.

  • Make sure to use full sentences with correct case and punctuation, for example:

    Fixed issue with non-ascii contents in doctest text files
    -- by :user:`contributor-gh-handle`.
    

    Use the past tense or the present tense a non-imperative mood, referring to what's changed compared to the last released version of this project.

[codspeed-hq[bot]]

CodSpeed Performance Report

Merging #9742 will not alter performance

_{Comparing tab1tha:docs/unify-contrib-docs (7dbfeca) with master (5ddeb06)}

Summary

✅ 14 untouched benchmarks

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.67%. Comparing base (5ddeb06) to head (7dbfeca). Report is 1008 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #9742      +/-   ##
==========================================
+ Coverage   98.60%   98.67%   +0.06%     
==========================================
  Files         117      117              
  Lines       35807    35807              
  Branches     4250     4250              
==========================================
+ Hits        35307    35331      +24     
+ Misses        340      320      -20     
+ Partials      160      156       -4     

Flag	Coverage Δ
CI-GHA	98.55% <ø> (+0.05%)	:arrow_up:
OS-Linux	98.24% <ø> (+0.05%)	:arrow_up:
OS-Windows	95.99% <ø> (ø)
OS-macOS	97.30% <ø> (-0.01%)	:arrow_down:
Py-3.10.11	95.55% <ø> (-1.61%)	:arrow_down:
Py-3.10.15	97.72% <ø> (ø)
Py-3.11.10	97.78% <ø> (+<0.01%)	:arrow_up:
Py-3.11.9	97.22% <ø> (ø)
Py-3.12.7	98.26% <ø> (ø)
Py-3.13.0	98.24% <ø> (+0.88%)	:arrow_up:
Py-3.9.13	97.07% <ø> (ø)
Py-3.9.20	97.63% <ø> (ø)
Py-pypy7.3.16	97.26% <ø> (?)
VM-macos	97.30% <ø> (-0.01%)	:arrow_down:
VM-ubuntu	98.24% <ø> (+0.05%)	:arrow_up:
VM-windows	95.99% <ø> (ø)

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[tab1tha]

Thank you for the reviews. I should be able to look through and push the changes later today.

[webknjaz]

@tab1tha hey, we talked about improving the changelog fragments instructions back at the sprint. I thought you submitted a PR, but I don't see it. So I suppose you must've kept the changes locally. Could you push them to Git? I remember there being some great ideas that I wanted to incorporate…

[tab1tha]

@tab1tha hey, we talked about improving the changelog fragments instructions back at the sprint. I thought you submitted a PR, but I don't see it. So I suppose you must've kept the changes locally. Could you push them to Git? I remember there being some great ideas that I wanted to incorporate…

Hi @webknjaz , Sure, I'll do that. It's possible that the changes are still local.

Will also look into the comments on this pull request. I have some things to wrap up but you can expect to see the code by tomorrow evening!

Thank you for reminding me ⭐

[webknjaz]

@tab1tha thank you! Also, please feel free to follow #4281 to request an org invitation if you'd like to display a badge for your GH profile :)

[webknjaz]

Hey @tab1tha! How are you? Have you had a chance to locate your notes yet?