|
1 | 1 | # Contribution Guidelines |
2 | 2 |
|
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: |
4 | 27 | - the section line numbers in the header banner |
5 | 28 | - the date of the update |
6 | 29 | - and the library documentation for technique links |
7 | 30 |
|
8 | 31 | 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. |
9 | 32 |
|
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. |
13 | 33 |
|
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? |
18 | 35 | There's a few steps that should be taken: |
19 | 36 | 1. Make sure to add the technique name in the enums of all the techniques in the appropriate place. |
20 | 37 | 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) |
21 | 38 | 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. |
22 | 39 |
|
23 | 40 |
|
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. |
0 commit comments