Skip to content

Latest commit

 

History

History
12 lines (7 loc) · 870 Bytes

CONTRIBUTING.md

File metadata and controls

12 lines (7 loc) · 870 Bytes

Contribution Guidelines

I want to add a new technique, how would I do that?

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

I want to make a major change to the library

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 ;)

I want to contribute but there's something that I don't understand about the library code

You can create an issue, and I will reply within 24 hours. We have too much free time on our hands in reality.