Skip to content

Commit

Permalink
Merge pull request #714 from Ana06/docu
Browse files Browse the repository at this point in the history
Improve documentation
  • Loading branch information
Ana06 authored Oct 20, 2023
2 parents cc337bc + 8d1485a commit af998db
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 11 deletions.
33 changes: 25 additions & 8 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,33 @@ body:
attributes:
label: Environment
description: |
Include details about your environment such as:
**Run `VM-Get-Host-Info` and paste the output (assuming you have installed the `vm.common` package).**
- host OS and virtualization software
- VM OS version and service pack
- VM OS ram and HDD space / usage
- VM PowerShell version
- VM Chocolatey version
- VM Boxstarter version
Include the following details about your environment:
- **Virtualization software**: VMWare, VirtualBox, etc.
- **VM OS version**: run `(Get-CimInstance Win32_OperatingSystem).version` in Powershell
- **VM PowerShell version**: run `$PSVersionTable.PSVersion.ToString()` in Powershell
- **VM Chocolatey version**: run `choco --version`
- **VM Boxstarter version**: run `choco info -l -r "boxstarter"`
- **Output of `VM-Get-Host-Info`** that will be available if the `vm.common` package has been install: run `VM-Get-Host-Info` in PowerShell with admin rights
placeholder: |
- Virtualization software:
- VM OS version:
- VM PowerShell version:
- VM Chocolatey version:
- VM Boxstarter version:
- Output of `VM-Get-Host-Info`:
validations:
required: true
- type: textarea
id: extra-info
attributes:
label: Additional Information
description: |
Any additional information, configuration or data that might be necessary to understand and reproduce the issue. For example:
- Console output
- The log files `C:\ProgramData\_VM\log.txt` and `C:\ProgramData\chocolatey\logs\chocolatey.log`
Text logs are preferred over screenshots.
- type: dropdown
id: ci
attributes:
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: 💡 Feature proposal
description: Propose a new feature or improvement.
body:
- type: markdown
attributes:
value: |
Thanks for helping improving VM-Packages. Before submitting your issue:
- **If you want to propose a new tool/package, use the [NEW PACKAGE](https://github.com/mandiant/VM-Packages/issues/new?labels=%3Anew%3A+package&template=new_package.yml&title=Package+proposal%3A+%3Cpackage_name%3E.vm) or [NEW METAPACKAGE](https://github.com/mandiant/VM-Packages/issues/new?labels=%3Anew%3A+package&template=new_metapackage.yml&title=Metapackage+proposal%3A+%3Cpackage_name%3E.vm) template instead and provide all the information requested there.** This help us tracking proposals and speeds up the package creation process.
- If you want to report a bug, use the [bug issue type](https://github.com/mandiant/VM-Packages/issues/new?labels=%3Abug%3A+bug&template=bug.yml) instead and provide all the information requested there. Otherwise we won't be able to help.
- Check the [open issues](https://github.com/mandiant/VM-Packages/issues) and ensure there is not already a similar issue. If there is already a similar issue, please add more details there instead of opening a new one.
- type: textarea
id: problem
attributes:
label: Details
description: The more details, the better!
validations:
required: true
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
This repository contains the source code for packages supporting the following analysis environment projects:
* [FLARE VM](https://github.com/mandiant/flare-vm)
* [CommandoVM](https://github.com/mandiant/commando-vm)
* [ThreatPursuit VM](https://github.com/mandiant/ThreatPursuit-VM)

> Packages do not contain actual software distributions. Packages are PowerShell scripts that only contain instructions for obtaining and configuring tools. See [Chocolatey legal information](https://docs.chocolatey.org/en-us/information/legal) for more details.
Expand All @@ -17,12 +16,13 @@ The packages stored in this repository are automatically built and pushed to a p
The installation of packages relies on [Chocolatey](https://chocolatey.org/).

# Contributing
To report problems or to suggest new tools please open a new [Issue](https://github.com/mandiant/VM-Packages/issues).
To propose new tools, to report problems, and to suggest improvements please open a new [issue](https://github.com/mandiant/VM-Packages/issues).
Ensure you select the correct issue type and provide all the requested information.

Please see the [Wiki](https://github.com/mandiant/VM-Packages/wiki) for documentation on how to create a package using our established best practices.

# Open Source Packages
Open sourcing the installation packages allows the community to not only suggest new tools, improvements, and report bugs, but to help implement them. It's now very transparent how and what gets installed. Moreover, we can use GitHub Actions (free for open-source repositories) for testing and automations. This reduces manual maintenance and simplifies contributions.

## Automation
Once a package is submitted, our pull request automations test the package to see if it builds and installs correctly. Additionally, we use GitHub Actions to build and test each package on a daily basis to check for any errors. Simply being aware of broken packages should quickly solve a lot of problems VM users faced in the past.
Once a package is submitted, our pull request automations test the package to see if it builds and installs correctly. Additionally, we use GitHub Actions to build and test each package on a daily basis to check for any errors (see [Daily Failures Wiki page](https://github.com/mandiant/VM-Packages/wiki/Daily-Failures)). Simply being aware of broken packages should quickly solve a lot of problems VM users faced in the past.

0 comments on commit af998db

Please sign in to comment.