Skip to content

Commit 5cdd974

Browse files
committed
slight contribution guideline changes
1 parent 61f46e1 commit 5cdd974

2 files changed

Lines changed: 18 additions & 7 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# MAKE SURE TO READ THE CONTRIBUTION GUIDELINES BEFORE CONTINUING!
1+
## MAKE SURE TO READ THE CONTRIBUTION GUIDELINES BEFORE CONTINUING!
2+
3+
<br>
24

35
## What does this PR do?
46
- [ ] Add a new technique

CONTRIBUTING.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
11
# Contribution Guidelines
22

3-
# I want to add a new technique, how would I do that?
4-
There used to be a complicated process in adding techniques, but that's now been replaced with a tool that prompts you on the new technique details and updates the library code automagically. You can check out the python script at auxiliary/add_technique.py
3+
## I want to add a new technique, how would I do that?
4+
There used to be a complicated process in adding techniques, but that's now been replaced with a tool that prompts you on the new technique details and updates the library code automagically. You can check out the python script at `auxiliary/add_technique.py`
55

66

7-
# I want to make a major change to the library
8-
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 we can discuss on discord (`kr.nl`). I don't bite ;)
7+
## I want to make a major change to the library
8+
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 discord (`kr.nl` or `shenzken`).
99

1010

11-
# I want to contribute but there's something that I don't understand about the library code
12-
You can create an issue, and I will reply within 24 hours. We have too much free time on our hands in reality.
11+
## I want to contribute but there's something that I don't understand about the library code
12+
You can create an issue, and I will reply within 24 hours. We have too much free time on our hands in reality.
13+
14+
15+
## Extra
16+
We have a tool that can update the MIT file and other details of the library with a python script for maintenance purposes. The script at `auxiliary/updater.py` will update:
17+
- the section line numbers in the header banner
18+
- the date of the update
19+
- the MIT file by copying the GPL file and removing every GPL code (so that you don't have to make the same changes on 2 different files separately, just focus on vmaware.hpp and let the script manage the vmaware_MIT.hpp file)
20+
21+
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.

0 commit comments

Comments
 (0)