Contributing Code

this is a stub for now, this place deserves better

You might be here because you found something you could improve in Gwion. Please open an issue describing the problem and how you might address it.

Dependencies

You can do this through the github site, or command-line tools like gh or hub. See Further Reading.

Clone the url of your fork

git clone --recursive https://github.com/<your username>/Gwion

Edit some files with your favorite text editor

cd Gwion
vim src/path/to/file

make

make test

make -C util clean && make -C ast clean && make clean
make

git add path/to/changed/files

git commit -m "Something meaningful about why we are here"
git push

It is recommended that you follow our styleguide for commit messages

You can do this through the github site, or command-line tools like gh or hub. See Further Reading.

It is recommended you submit a PR to a branch other than master;

If a branch that directly concerns your specific PR is readily available, PR to that
Otherwise PR to dev

You can now sit back and wait for your pull request to be reviewed. If it's accepted, congrats! 🎉 You've made a contribution!