mandiant / mandiant/VM-Packages
Improve VM-install helper functions documentation
Open
Nobody has claimed this yet.
:gem: enhancement
:page_facing_up: documentation
- Dominant language
- PowerShell
- Stars
- 246
- Forks
- 98
- Avg merge
- 9h 30m
- Merged PRs (30d)
- 7
Description
`VM-Install-From-Zip` can install .exe in a ZIP, but we are also using it for `.bat` and `.py`. I think this is ok, as it allows us to reuse the same code, but we should document better the different installer helper function and also the issue template.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the VM-Install-From-Zip helper and the issue template, then read the surrounding installer helper documentation. Document the supported .exe, .bat, and .py use cases and clarify the different helper functions and issue-template expectations; the work is done when those uses are understandable from the updated documentation.
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
- 45/100