doc: Add directions for using dev containers

[fruitymedley]

Add directions to documentation for using dev containers

Description

• Add directions to CONTRIBUTING.rst detailing the following
  • Installing Dev Containers extension
  • Opening repo in Dev Containers
  • Final environment setup
• Remove install pre-commit/setuptools instructions as this is handled automatically by Dev Containers

Types of Changes

• Core
• Bugfix
• New feature
• Enhancement/optimization
• Documentation

Issues Fixed or Closed by This PR

192

Checklist

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• I have tested the changes and verified that they work and don't break anything (as well as I can manage).

Summary by Sourcery

Update the contributing documentation to include instructions for using dev containers, including installing the extension, opening the repo, and environment setup. Remove the pre-commit and setuptools installation instructions as they are now handled automatically by dev containers.

Documentation:

• Add instructions for using dev containers to the contributing documentation.
• Remove pre-commit and setuptools installation instructions.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request enhances the project's documentation by providing instructions for using Dev Containers. It guides users through installing the Dev Containers extension, opening the repository within a Dev Container, and completing the necessary environment setup. Additionally, it removes the now-redundant instructions for manually installing pre-commit and setuptools, as these are automatically handled by the Dev Container.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Added instructions for using Dev Containers, including installation, setup, and environment configuration.	Added a section detailing the installation of the Dev Containers extension. Added a section on how to open the repository in Dev Containers. Added a section on completing the environment setup within Dev Containers.	CONTRIBUTING.rst
Removed manual installation instructions for pre-commit and setuptools.	Removed the instruction to manually install pre-commit. Removed the instruction to manually install setuptools. Updated the documentation to reflect that Dev Containers handle these dependencies automatically.	CONTRIBUTING.rst

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @fruitymedley - I've reviewed your changes - here's some feedback:

Overall Comments:

• Thanks for adding this documentation, it will be helpful for new contributors.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[Ckk3]

Great job! The explanation is really clear. I just added some comments about updating the old tutorial since it was never really what we used.

Also, I think we should mention this file in the Contribuiting section on README.md, so new contributors can find it more easily. What do you think?

[fruitymedley]

Updated with subsections for manual environment setup and dev container setup.

Doc screenshots:

[fruitymedley]

I also added a reference to this doc in the README.md

[Ckk3]

Nice!