|
1 | 1 | # Contribution Guidelines
|
2 | 2 |
|
| 3 | +If you have any questions or inquiries, our contact details are in the README. |
| 4 | + |
3 | 5 | ## 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` |
| 6 | +There's a few steps that should be taken: |
| 7 | +1. Make sure to add the technique name in the enums of all the techniques in the appropriate place. |
| 8 | +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) |
| 9 | +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. |
5 | 10 |
|
6 | 11 |
|
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`). |
9 | 12 |
|
10 | 13 |
|
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 | +## I want to make a major change to the library |
| 16 | +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. |
14 | 17 |
|
15 | 18 | ## Extra
|
16 |
| -We have a useful script at `auxiliary/updater.py` will update: |
| 19 | +We have a useful script at `auxiliary/updater.py` that will update: |
17 | 20 | - the section line numbers in the header banner
|
18 | 21 | - the date of the update
|
| 22 | +- the library documentation |
19 | 23 |
|
20 |
| -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. |
| 24 | +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