SSWConsulting / SSWConsulting/SSW.CleanArchitecture

📝 README - PowerShell Execution Policy

Open
#343 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Documentation
Dominant language
C#
Stars
199
Forks
37
PR merge metrics
No merged PRs in 30d

Description

Hi @danielmackay

Pain

When following instructions in README.md to start project, I found that I could not run command .\up.ps1 due to the ExecutionPolicy set in PowerShell.

Though I was able to work around this using the command powershell.exe -ExecutionPolicy Unrestricted .\up.ps1, I am not sure that this is the best solution.

Tasks
  • Add best-practice instruction to README.md allow up.ps1 to be securely run

Thanks!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing startup instructions in README.md and the referenced up.ps1 script. Check the appropriate PowerShell ExecutionPolicy guidance for running that script securely, then update README.md with the recommended instruction. Done means a new user can follow the README and run up.ps1 without the reported policy error.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.