-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CONTRIBUTING & README] Improve documentation
Add CONTRIBUTING file with information about CLA and Google's code of conduct to follow Google conventions/policies and make contributing easier. Improve information in the README too.
- Loading branch information
Showing
2 changed files
with
61 additions
and
10 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,34 @@ | ||
# 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 VM-Packages! :sparkling_heart: | ||
|
||
|
||
## Repository structure | ||
|
||
This repository contains the source code of [tool packages](https://github.com/mandiant/VM-Packages/tree/main/packages) that supports the analysis enviroment projects [FLARE-VM](https://github.com/mandiant/flare-vm) and [CommandoVM](https://github.com/mandiant/commando-vm). | ||
|
||
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, read the issue template carefully and provide all the 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. | ||
|
||
### Check the Wiki | ||
|
||
Please see our [Wiki](https://github.com/mandiant/VM-Packages/wiki) for documentation on how to create a package using our established best practices. | ||
|
||
|
||
## 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