Skip to content

Latest commit

 

History

History
20 lines (16 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

20 lines (16 loc) · 1.14 KB

Contributing to AuditoryStimuli.jl

I warmly welcome any contributions from the community. This may take the form of feedback via the issues list, bug reports (also via the issues list), code submission (via pull requests). Please feel free to suggest features, or additional stimuli you are interested in. Or if you just want to show support, click the star button at the top of the page.

This repository makes extensive use of GitHub actions. When you submit a pull request the continuous integration will kick in to gear. The code in your pull request will then be automatically tested against several version of Julia, and on several operating systems to ensure that it doesn't break anything.

Additionally the documentation will be rebuilt based on your pull request. This will allow you to check that it renders correctly and your changes are realised. Further, a spell check will be performed on the pull request.

Don't be disheartened if the continuous integration results come back with a red cross initially. You can push further changes to fix any issues that arise. And if you get stuck just ping @rob-luke and we will solve the issues together.