Contributing

Thanks for considering contributing to this project! It would be great to have your help. The guides below may be helpful to get you started.

How can I contribute?

Add more Ink test cases!
Add more JSON test cases!
Add drivers for Ink runtimes!
Add drivers for Ink compilers!
Fix any outstanding TODO!
Some yet unimagined and unlisted improvement!

Adding a .json test case

Copy bytecode/B001 to bytecode/B0NN where N is an unused testcase number.
Edit bytecode/B0NN/bytecode.json with your new test case.
Update the input and the expected output (bytecode/B0NN/input.txt & bytecode/B0NN/transcript.txt).
Update bytecode/B0NN/metadata.json for your testcase.

Adding a .ink test case

Copy ink/I001 to ink/I0NN where N is an unused testcase number.
Edit ink/I0NN/story.json with your new test case.
Update the input and the expected output (ink/I0NN/input.txt & ink/I0NN/transcript.txt).
Update ink/I0NN/metadata.json for your testcase.