Changes between Version 4 and Version 5 of FAQ

02/12/08 17:05:32 (12 years ago)

Merge "ContributionFAQ" with "FAQ"


  • FAQ

    v4 v5  
    1 = Frequently Asked Questions about Open TURNS = 
     1= Frequently Asked Questions about OpenTURNS = 
    37== Troubleshooting == 
    4246==== Failures during the 'make check' or 'make installcheck' stage ==== 
    4347Your installation of R cannot find gs, the ghostscript interpret. It is a problem related to the packaging of R, you can fix it by installing gs. 
     51== Contribution == 
     53You can find here answers to some of the most frequently asked questions about contributing into OpenTURNS' project. 
     55=== Bug tracking === 
     56==== I found a bug, how can i report it ? ==== 
     57Two ways to do that : 
     58 * Subscribe to the specific OpenTURNS's mailing-list : 
     59 * Send a mail containing the following details at this address : 
     60  * a short description as mail subject 
     61  * in mail body, put your affected version of your OpenTURNS (if you use a development version, please send the svn release version) 
     62  * a full description of your bug 
     63  * a way to to reproduce the bug 
     64Or : 
     65 * Send a login request at 
     66 * Logon on this site and use our bug tracker 
     70==== I found a bug and i have written the patch, how can i submit ?  ==== 
     71The only constraint for submitting patches is to provide it under "GNU LGPL" compliant licence. If it is not explicitly specified, your patches will be considered licenced under the terms of "GNU LGPL". 
     73The best way to submit patches is : 
     75svn checkout openturns 
     76svn export openturns openturns.orig 
     77svn export openturns opentunrs.patched 
     79At this point, you modify the sources in the openturns.patched directory. 
     81diff -Nura openturns.orig openturns.patched > mypatch.diff 
     83Now, you can follow the previous instructions but don't forget to join your patch to the bug report. 
     85''Note: you can however use directly the svn repository if you are fluent in subversion.'' 
     89==== I found a lot of bugs and i have a lot of patches, how can i integrate them into OpenTURNS' upstream ? ==== 
     90Join us ! And contribute to OpenTURNS's development (see below). 
     95=== Examples, documentation & site content === 
     96==== I'm OpenTURNS' user and i have written some examples to explain undocumented functions, what can i do ? ==== 
     97Your writings must be under "GNU FDL", so you can submit your example and your comments to after [wiki:HowToUseMailingList subscribing] to this one. 
     101==== I want to improve documentation which is included in OpenTURNS' release, how can i do ? ==== 
     102Currently, contributing to included documentation follows the same rules as contributing to source code (see [wiki:ContributionFAQ#Howtojoindevelopmentteam how to join development team ?]). 
     106==== I found some mistakes or i want to introduce some useful content on the website, can i edit them ? ==== 
     107For the first time, post your suggestions as bugs, by following bug's reporting instructions. 
     111=== Source code === 
     112==== How to join development team ? ==== 
     113Contact one of the OpenTURNS' developers or, and explain what you want to do in development team. After that, we'll contact you.