mandiant/flare-vm
1
0
Fork 0
mirror of https://github.com/mandiant/flare-vm.git synced 2026-10-12 02:18:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[CONTRIBUTING] Add CONTRIBUTING file

Browse Source 
Add CONTRIBUTING file with information about CLA and Google's code of
conduct to follow Google conventions/policies and make contributing
easier. Move the information of the _Contributing_ section of the README
to this document.
This commit is contained in:
Ana Maria Martinez Gomez
2025-01-15 15:33:31 +01:00
parent 8eaae155fe
commit 05d6bbe007
2 changed files with 36 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+33
View File
@@ -0,0 +1,33 @@
# How to contribute
Want to open an issue or send a code contribution?
Read the information below to learn how.
We are looking forward working with you to improve FLARE-VM! :sparkling_heart:
## Repository structure of FLARE-VM
The FLARE-VM code is spited in two repositories:
- **[FLARE-VM](https://github.com/mandiant/flare-vm) (this repository)**: FLARE-VM installation script, and configuration
- [Submit improvement proposals and report issues related to the installer](https://github.com/mandiant/flare-vm/issues/new/choose)
- **[VM-Packages](https://github.com/mandiant/VM-Packages)**: Source code of tool packages used by FLARE-VM (this repository) and [CommandoVM](https://github.com/mandiant/commando-vm)
- [Documentation and contribution guides for tool packages](https://github.com/mandiant/VM-Packages/wiki)
- [Submit new tool packages or report package related issues](https://github.com/mandiant/VM-Packages/issues/new/choose)
Before opening an issue, ensure you select the correct repository ([FLARE-VM](https://github.com/mandiant/flare-vm) for the FLARE-VM installer, [VM-Packages](https://github.com/mandiant/VM-Packages) for concrete tools and packages).
Select the correct issue type and read the issue template carefully to ensure you provide all needed information.
## Before contributing code
### Sign our Contributor License Agreement
Contributions to this project must be accompanied by a [Contributor License Agreement](https://cla.developers.google.com/about) (CLA).
You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project.
If you or your current employer have already signed the Google CLA (even if it was for a different project), you probably don't need to do it again.
Visit <https://cla.developers.google.com/> to see your current agreements or to sign a new one.
## Review our community guidelines
This project follows [Google's Open Source Community Guidelines](https://opensource.google/conduct).
README.md
+3 -11
View File
@@ -107,7 +107,7 @@ The installer will use [CustomStartLayout.xml](https://raw.githubusercontent.com
##### Things to Consider:
- Items in the .xml that are not installed will not display in the taskbar (no broken links will be pinned)
- Only applications (.exe files) or shortcuts to applications can be pinned.
- Only applications (`.exe` files) or shortcuts to applications can be pinned.
- If you would like to pin something that isn't an application, consider creating a shortcut that points to `cmd.exe` or `powershell` with arguments supplied that will perform that actions you would like.
- If you would like to make something run with admin rights, consider making a shortcut using `VM-Install-Shortcut` with the flag `-runAsAdmin` and pinning the shortcut.
@@ -125,18 +125,10 @@ For example:
For more examples, check the default configuration file: [config.xml](https://raw.githubusercontent.com/mandiant/flare-vm/main/config.xml).
## Contributing
Want to get started contributing? See the links below to learn how. We are looking forward working with you to improve FLARE-VM! :sparkling_heart:
### FLARE-VM (this repository)
* FLARE-VM installation script, and configuration: https://github.com/mandiant/flare-vm
* [Submit improvement proposals and report issues related to the installer](https://github.com/mandiant/flare-vm/issues/new/choose)
### VM-Packages
* Repository of all tool packages: https://github.com/mandiant/VM-Packages
* [Documentation and contribution guides for tool packages](https://github.com/mandiant/VM-Packages/wiki)
* [Submit new tool packages or report package related issues](https://github.com/mandiant/VM-Packages/issues/new/choose)
- Check our [CONTRIBUTING guide](/CONTRIBUTING.md) to learn how to contribute to the project.
## Troubleshooting
If your installation fails, please attempt to identify the reason for the installation error by reading through the log files listed below on your system: