contributor docs improvements (#314)

* Improving the contributor guide

- Making the machine setup guide more obvious
- Adding the missing runtimes
- Fixing devcontainer not adding python

* Adding package managers to manual steps

* Missed some links

* Adding maven and gradle as required installs

* Update docs/setup.md

Co-authored-by: Copilot <[email protected]>

* Update CONTRIBUTING.md

Co-authored-by: Copilot <[email protected]>

---------

Co-authored-by: Copilot <[email protected]>

Author: aaronpowell

.devcontainer/devcontainer.json

@@ -19,7 +19,8 @@
     "ghcr.io/devcontainers/features/node:latest": {},
     "ghcr.io/devcontainers-community/features/deno": {},
     "ghcr.io/devcontainers/features/go:latest": {},
-    "ghcr.io/devcontainers/features/rust:latest": {}
+    "ghcr.io/devcontainers/features/rust:latest": {},
+    "ghcr.io/devcontainers/features/python:1": {}
   },
   "customizations": {
     "vscode": {

.devcontainer/post-create.sh

@@ -22,4 +22,7 @@ dotnet new install Aspire.ProjectTemplates
 echo Installing Bun
 curl -fsSL https://bun.sh/install | bash
 
+echo Installing uvicorn
+pip install uvicorn
+
 echo Done!

.vscode/tasks.json

@@ -6,6 +6,38 @@
       "type": "shell",
       "command": "echo '#nullable enable' > src/${input:projectName}/PublicAPI.Shipped.txt && echo '#nullable enable' > src/${input:projectName}/PublicAPI.Unshipped.txt",
       "problemMatcher": []
+    },
+    {
+        "label": "build",
+        "command": "dotnet",
+        "type": "process",
+        "args": [
+            "build",
+            "/property:GenerateFullPaths=true",
+            "/consoleloggerparameters:NoSummary;ForceNoAlign"
+        ],
+        "problemMatcher": "$msCompile"
+    },
+    {
+        "label": "publish",
+        "command": "dotnet",
+        "type": "process",
+        "args": [
+            "publish",
+            "/property:GenerateFullPaths=true",
+            "/consoleloggerparameters:NoSummary;ForceNoAlign"
+        ],
+        "problemMatcher": "$msCompile"
+    },
+    {
+        "label": "watch",
+        "command": "dotnet",
+        "type": "process",
+        "args": [
+            "watch",
+            "run"
+        ],
+        "problemMatcher": "$msCompile"
     }
   ],
   "inputs": [

CONTRIBUTING.md

@@ -35,6 +35,8 @@ The documentation for the .NET Aspire Community Toolkit is available on the [Mic
 
 Anyone can create a Pull Request by forking the .NET Aspire Community Toolkit Repository. Here is how you can [Create a Pull Request from fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). Once you fork the .NET Aspire Community Toolkit repo, it is essential to create all changes in the feature branch of your forked repository. If you have the changes in the forked feature branch, you can then create a Pull Request in the main .NET Aspire Community Toolkit.
 
+If this is your first time running the solution, be sure to familiarise yourself with [how to setup the development environment](./docs/setup.md).
+
 ### 📦 Add New Integration <a name="integration"></a>
 
 For more detailed information on how to add a new integration, refer to the [building an integration](./docs/create-integration.md) documentation.

docs/create-integration.md

@@ -14,19 +14,7 @@ The repository structure for the .NET Aspire Community Toolkit is as follows:
 
 ## 🛠️ Setting up your Development Environment
 
-The recommended development environment for contributing to the .NET Aspire Community Toolkit is [VS Code](https://code.visualstudio.com/) using the [`devcontainer`](https://code.visualstudio.com/docs/remote/containers) extension. This will ensure that you have all the necessary tools and dependencies installed to build and test the toolkit.
-
-### Manual Setup
-
-If you prefer not to use `devcontainer`, you can manually set up your development environment by installing the following tools:
-
--   [.NET 8](https://dotnet.microsoft.com/download/dotnet/8.0)
--   [Node.js LTS](https://nodejs.org/en/)
--   [Java JDK 11](https://learn.microsoft.com/java/openjdk/download)
--   [Docker](https://docs.docker.com/get-docker/)
-    -   Podman is also supported, but Docker is recommended for consistency.
-
-And of course, an editor such as Visual Studio, JetBrains Rider or emacs.
+Be sure to read through the [Setting up your Development Environment](./setup.md) guide to get your environment set up correctly, after all, there are a lot of runtimes and environments that are supported by the toolkit, so setup can be a bit complex!
 
 ## 🚀 Getting Started
 

docs/setup.md

@@ -0,0 +1,32 @@
+# 🛠️ Setting up your Development Environment
+
+Because the Community Toolkit consists of integrations across a lot of different runtimes, setting up a development environment can be a bit complex. Below we outline the recommended approach to developing, as well as a manual setup if you prefer not to use the recommended approach.
+
+## ✅ Recommended Setup
+
+The easiest, and recommended way is to use [VS Code](https://code.visualstudio.com/) with the [`devcontainer`](https://code.visualstudio.com/docs/remote/containers) extension.
+
+This will run the development environment in a container, install all the necessary tools and dependencies, add extensions to align with our contribution guidelines, and ensure that you have a consistent development environment.
+
+> Note: There is an issue with devcontainers in that the ports bound by the DCP (the thing the app host uses to orchestrate behind the scenes) are not exposed to the host machine, meaning that the HTTP endpoints fail to resolve. This can be fixed by manually [forwarding the port](https://code.visualstudio.com/docs/editor/port-forwarding). This is a known issue in Aspire and being tracked for a 9.1 fix 🤞.
+
+### 🛠️ Manual Setup
+
+If you prefer not to use `devcontainer`, you can manually set up your development environment by installing the following tools:
+
+-   [.NET 8](https://dotnet.microsoft.com/download/dotnet/8.0) and [.NET 9](https://dotnet.microsoft.com/download/dotnet/9.0)
+-   [Node.js LTS](https://nodejs.org/en/)
+    -   [Yarn 2](https://yarnpkg.com/getting-started/install)
+    -   [pnpm](https://pnpm.io/)
+-   [Java JDK 11](https://learn.microsoft.com/java/openjdk/download)
+    -   You'll also need [Gradle](https://gradle.org/install/) and [Apache Maven](https://maven.apache.org/download.cgi)
+-   [Bun](https://bun.sh)
+-   [Deno 2](https://deno.land/)
+-   [Go 1.23](https://golang.org/)
+-   [Python 3](https://www.python.org/downloads/)
+    -   [Uvicorn](https://www.uvicorn.org/)
+-   [Rust](https://www.rust-lang.org/tools/install)
+-   [Docker](https://docs.docker.com/get-docker/)
+    -   Podman is also supported, but Docker is recommended for consistency.
+
+And of course, an editor such as Visual Studio, JetBrains Rider or emacs.