-
Notifications
You must be signed in to change notification settings - Fork 950
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CONTRIBUTING] Add CONTRIBUTING file
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.
- Loading branch information
Showing
2 changed files
with
36 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters