Skip to content

Commit 90edaa2

Browse files
committed
feat: Update Contributing docs with more info on local development
1 parent 3908307 commit 90edaa2

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/ScriptModuleRepositoryTemplate/TemplateRepoFiles/docs/Contributing.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,19 @@
22

33
Feel free to open an issue or pull request.
44

5+
## Local development
6+
7+
This PowerShell module is developed using Visual Studio Code.
8+
If you encounter any issues developing on your local machine, you can use [Docker Desktop](https://www.docker.com/products/docker-desktop/) and the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) VS Code extension to develop in a Docker container with all of the required dependencies, so that you do not have to install them locally.
9+
You may also develop in your web browser with GitHub Codespaces to avoid needing to put any code or dependencies on your local machine.
10+
11+
### Building and testing
12+
13+
The code is built and tested by CI/CD pipelines on every commit to the `main` branch and every PR opened against the `main` branch.
14+
15+
When developing locally, you can use [the VS Code tasks](/.vscode/tasks.json) to simulate the build and test process and be notified of any problems before pushing your code up to the remote repository.
16+
In VS Code, open the command palette (Ctrl+Shift+P) and select `Tasks: Run Build Task` or `Tasks: Run Test Task`.
17+
518
## 🚀 Publishing new versions
619

720
A prerelease version of the module is published automatically on every commit to the `main` branch.

0 commit comments

Comments
 (0)