Skip to content

Commit 7a07c63

Browse files
authored
Update CONTRIBUTING.md
1 parent 0a58e79 commit 7a07c63

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
# Contribution Guidelines
22

3+
If you have any questions or inquiries, our contact details are in the README.
4+
35
## 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.
510

611

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`).
912

1013

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.
1314

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.
1417

1518
## 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:
1720
- the section line numbers in the header banner
1821
- the date of the update
22+
- the library documentation
1923

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

Comments
 (0)