The ViennaRNA Package is developed by humans and consequently may contain bugs that prevent proper operation of the implemented algorithms. If you think you have found any of those nasty animals, please help us to improve our software by reporting the bug to us.
The ViennaRNA Package also is open-source software, which means that everybody can have a closer look into our implementations to understand and potentially extend it's functionality. If you implemented any novel feature into the ViennaRNA Package that might be of interest to a larger community, please don't hesitate to ask for merging of your code into our official source tree. See the Pull Request Process section below to find information on how to do that.
Please note that we have a code of conduct. Please follow it in all your interactions with this project.
If you wish to contribute to this project, please first discuss any proposed changes with the owners and main developers. You may do that either through making an issue at our official GitHub presence, by email, or any other personal communication with the core developer team.
More importantly, if you wish to contribute any files or software, you need to agree to our ViennaRNA Package Contributors License Agreement (CLA)! Otherwise, your contributions can't be merged into our source tree. See below for further information and the full CLA details.
uncrustify
together with our config located in misc/uncrustify.cfg
to accomplish that.static
.vrna_
for any symbol you add to the API of our library! Preprocessor macros in header files require the prefix in capital letters, i.e. VRNA_
.tests
directory and is split into tests for the C-library, executable programs, and the individual scripting language interfaces.make check
to ensure that all other test suites still run properly with your applied changes!user-contrib
branch. Pull requests to the master
branch will be rejected to keep its history clean.user-contrib
branch usually find their way into the next release of the ViennaRNA Package. However, please note that the core developers may decide to include your changes in a later version.Thank you for your interest in contributing to the ViennaRNA Package ("We" or "Us").
Before contributing, please note that we adopted a standard Contributors License Agreement (CLA) agreement provided by Project Harmony, a community-centered group focused on contributor agreements for free and open source software (FOSS).
This contributor agreement ("Agreement") documents the rights granted by contributors to Us. To make this document effective, please sign it and send it to Us by email to rna@t.nosp@m.bi.u.nosp@m.nivie.nosp@m..ac..nosp@m.at.
The respective CLA PDF documents are available in the doc/CLA directory of the distribution tarball, and online at our official ViennaRNA Website.