Difference between revisions of "Contributing to the development of packages/modules"

From Octave
Jump to navigation Jump to search
m (→‎One shot contribution: use codeline templae)
Line 3: Line 3:
  
 
== One shot contribution ==
 
== One shot contribution ==
In the OctaveForge site you can look for the package in question and get the latest version of the function you want to fix. This version could be unreleased, that is, it is not yet listed in the OctaveForge website and you will not get it by doing  
+
In the OctaveForge site you can look for the package in question and get the latest version of the function you want to fix. This version could be unreleased, that is, it is not yet listed in the OctaveForge website and you will ''not'' get it by doing {{Codeline|pkg -forge install my_package}} in the Octave prompt.
{{Code||<syntaxhighlight lang="octave" style="font-size:13px">
 
pkg -forge install my_package
 
</syntaxhighlight>}}
 
in the Octave prompt.
 
  
 
You can use this function in Octave if you copy on top of the old one (or rename the old one to *_old.m), but be careful because it may require other new functions. Anyway, you can get the latest and coolest version of any package from that site.
 
You can use this function in Octave if you copy on top of the old one (or rename the old one to *_old.m), but be careful because it may require other new functions. Anyway, you can get the latest and coolest version of any package from that site.
Line 18: Line 14:
 
You can also checkout the package in question using svn. For example if you wan to checkout the general package you would run
 
You can also checkout the package in question using svn. For example if you wan to checkout the general package you would run
  
<code>
+
<pre>svn co https://octave.svn.sourceforge.net/svnroot/octave/trunk/octave-forge/main general general_to_debug</pre>
> svn co https://octave.svn.sourceforge.net/svnroot/octave/trunk/octave-forge/main general general_to_debug
 
</code>
 
  
 
This will create a folder <code>general_to_debug</code> in your current directory. You can hack away as much as you can and then produce the
 
This will create a folder <code>general_to_debug</code> in your current directory. You can hack away as much as you can and then produce the
Line 26: Line 20:
  
 
=== Contributing new file or bundle of files ===
 
=== Contributing new file or bundle of files ===
There is a third way of contributing to OctaveForge. Lets say you do not want to be a developer but you have one or a bundle of functions you
+
There is a third way of contributing to OctaveForge. Lets say you do not want to be a developer but you have one or a bundle of functions you want to share with the commuity. You can use the [https://sourceforge.net/p/octave/feature-requests/ features request forum] (this will be also replaced by Agora when it is up and running). Upload your file (compressed if it is more than one) and lets us know that you did it by sending a mail to the mailing list. If there is anybody interested they will look at your code and give you suggestions. Speed up that process by adding a [http://en.wikipedia.org/wiki/List_of_FSF-approved_software_licenses GPL compatible license], preferably the latest GPL.
want to share with the commuity. You can use the [https://sourceforge.net/p/octave/feature-requests/ features request forum] (this will be also replaced by Agora when it is up and running). Upload your file (compressed if it is more than one) and lets us know
 
that you did it by sending a mail to the mailing list. If there is anybody interested they will look at your code and give you suggestions. Speed up that process by adding a [http://en.wikipedia.org/wiki/List_of_FSF-approved_software_licenses GPL compatible license], preferably the latest GPL.
 
  
 
== Being a forger ==
 
== Being a forger ==

Revision as of 04:35, 30 September 2012

All OctaveForge packages (this name will change as soon we have Agora online running) are hosted in this site. Here we discuss how you can contribute to the development of those packages. Lets say you have found a bug in a function of one package and you know how to fix it.

One shot contribution

In the OctaveForge site you can look for the package in question and get the latest version of the function you want to fix. This version could be unreleased, that is, it is not yet listed in the OctaveForge website and you will not get it by doing pkg -forge install my_package in the Octave prompt.

You can use this function in Octave if you copy on top of the old one (or rename the old one to *_old.m), but be careful because it may require other new functions. Anyway, you can get the latest and coolest version of any package from that site.

Once you have the newest version of the function, check if it still has the bug you found. If it doesn't somebody solved it already. If the problem still there go on an fix it!

Once you have fixed the bug, you can send a patch with your changes. How do you this? Check the developers help page.

Checking out the svn

You can also checkout the package in question using svn. For example if you wan to checkout the general package you would run

svn co https://octave.svn.sourceforge.net/svnroot/octave/trunk/octave-forge/main general general_to_debug

This will create a folder general_to_debug in your current directory. You can hack away as much as you can and then produce the patch and send it to the mailing list.

Contributing new file or bundle of files

There is a third way of contributing to OctaveForge. Lets say you do not want to be a developer but you have one or a bundle of functions you want to share with the commuity. You can use the features request forum (this will be also replaced by Agora when it is up and running). Upload your file (compressed if it is more than one) and lets us know that you did it by sending a mail to the mailing list. If there is anybody interested they will look at your code and give you suggestions. Speed up that process by adding a GPL compatible license, preferably the latest GPL.

Being a forger

If you want to be a more permanent member of our community, you can also request to be a Forge developer (name may change) following these instructions.


Let us know if there are more questions

Looking forward for your next contribution!

See also