Skip to content

Commit f7ced49

Browse files
committed
added french translation, removed KEYS.md, small contribution and security guideline updates, updates old links
1 parent c2b3ed6 commit f7ced49

File tree

7 files changed

+344
-130
lines changed

7 files changed

+344
-130
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
## What does this PR do?
66
- [ ] Add a new technique
77
- [ ] Add a new feature
8+
- [ ] Add a new README translation
89
- [ ] Improve code
910
- [ ] Fix bugs
1011
- [ ] Refactoring or code organisation

CONTRIBUTING.md

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,46 @@
11
# Contribution Guidelines
22

3-
We have a useful script at `auxiliary/updater.py` that will update:
3+
4+
Make sure to create your PR merge target to the `dev` branch and not the `main` branch. This is because all our prototype code is developed in `dev`, and we usually merge that branch to `main` at least once a week. it keeps our codebase organised and separated between a prototype that we cautiously don't think it's ready to be used by the public yet (especially if it's a new technique being introduced), and an upstream version that we've deemed to be practically ready.
5+
6+
7+
Also, please consider adding your name and github in the vmaware.hpp file and the README's credit sections. Your work is valuable to us, and we want to credit you for the improvements you've made.
8+
9+
10+
## Translations
11+
If you're making translations, please make sure that you actually speak the language, and you have the intention to be as accurate as possible.
12+
13+
What you SHOULDN'T translate are:
14+
- text that's in a codeblock
15+
- text in images
16+
- text of usernames
17+
- code
18+
- and other stuff that should obviously not be translated.
19+
20+
Using translation software like google translate is allowed, but only if you cross-check between the english and translation version to verify if it's done correctly.
21+
22+
The README is quite big, so this is quite an effort. I'm sure you have better thing to do in your life but if you can do this, it would be greatly appreciated :)
23+
24+
25+
## Code contributions
26+
If you're making code changes to the cli or header file, we have a useful script at `auxiliary/updater.py` that will update:
427
- the section line numbers in the header banner
528
- the date of the update
629
- and the library documentation for technique links
730

831
It's highly recommended to use this script before sending the PR so that all the above don't have to be manually updated, which can be time consuming and can potentially creep in some human errors.
932

10-
Also, make sure to create your PR merge target to the `dev` branch and not the `main` branch. This is because all our prototype code are developed in `dev`. We usually merge that branch to `main` at least once a week, and it keeps our codebase organised and separated between a prototype that we cautiously don't think it's ready to be used by the public yet (especially if it's a new technique being introduced), and an upstream version that we've deemed to be practically ready.
11-
12-
If you have any questions or inquiries, our contact details are in the README.
1333

14-
Lastly, consider adding your name and github in the vmaware.hpp file and the README's credit sections. Your work is valuable to us, and we want to credit you for the improvements you've made.
15-
16-
# Q&A
17-
### I want to add a new technique, how would I do that?
34+
## I want to add a new technique, how would I do that?
1835
There's a few steps that should be taken:
1936
1. Make sure to add the technique name in the enums of all the techniques in the appropriate place.
2037
2. Add the technique function itself in the technique section of the library. Make sure to add it in the right place, as there's preprocessor directives for each platform (Linux, Windows, and Apple)
2138
3. Add the technique in the technique table situated at the end of the header file. The score should be between 10 and 100. Although there are exceptions, it's advised to follow the aforementioned score range.
2239

2340

24-
### I want to make a major change to the library
25-
Depending on how big the change is, if the change is fairly small then just a simple PR is fine. But if it has hundreds of lines of code changes then it's best to create an issue prior to even starting to write the code, or you can discuss it with us, either works.
41+
## I want to make a major change to the library
42+
Depending on how big the change is, if the change is fairly small then just a simple PR is fine. But if it has hundreds of lines of code changes then it's best to create an issue prior to even starting to write the code, or you can discuss it with us, either works.
43+
44+
45+
## Notes
46+
If you have any questions or inquiries, our contact details are in the README.

KEYS.md

Lines changed: 0 additions & 97 deletions
This file was deleted.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ If you want to learn about the architecture and design of the library, head over
171171
>
172172
> Additionally, software could adjust the behaviour of their program based on the detected environment. It could be useful for debugging and testing purposes, while system administrators could manage configurations differently. Finally, some applications might want to legally restrict usage in VMs as a license clause to prevent unauthorized distribution or testing.
173173
>
174-
> There are also projects that utilise our tool such as [Hypervisor-Phantom](https://codeberg.org/Scrut1ny/Hypervisor-Phantom), which is an advanced malware analysis project that we helped strengthen their hypervisor environment and undetectability.
174+
> There are also projects that utilise our tool such as [Hypervisor-Phantom](https://github.com/Scrut1ny/Hypervisor-Phantom), which is an advanced malware analysis project that we helped strengthen their hypervisor environment and undetectability.
175175
176176
</details>
177177

README_CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ endif()
158158
>
159159
> 此外,软件可根据检测到的环境调整程序行为。这在调试和测试过程中颇具实用价值,同时系统管理员也能灵活管理配置方案。最后,某些应用程序可能需要通过许可证条款在法律层面限制虚拟机使用,以防止未经授权的分发或测试行为。
160160
>
161-
> 还有一些项目采用了我们的工具,例如 [Hypervisor-Phantom](https://codeberg.org/Scrut1ny/Hypervisor-Phantom),这是一个高级恶意软件分析项目,我们协助其强化了虚拟机监控程序环境并提升了隐蔽性。
161+
> 还有一些项目采用了我们的工具,例如 [Hypervisor-Phantom](https://github.com/Scrut1ny/Hypervisor-Phantom),这是一个高级恶意软件分析项目,我们协助其强化了虚拟机监控程序环境并提升了隐蔽性。
162162
163163
</details>
164164

0 commit comments

Comments
 (0)