Summer of Code - Getting Started
Since 2011 the GNU Octave project has successfully mentored:
in Summer of Code (SoC) programs by Google and ESA.
Those SoC programs aim to advertise open-source software development and to attract potential new Octave developers.
Steps toward a successful application
- 😉💬 We want to get to know you (before the deadline). Communicate with us.
- Join Octave Discourse or IRC for general discussion and to ask questions (Please do not use the bug tracker for general GSOC inquiries unrelated to specific bugs found with Octave.) Using a nickname is fine.
- Show us that you're motivated to work on Octave 💻. There is no need to present an overwhelming CV 🏆; evidence of involvement with Octave is more important.
- If you never talked to us, we will likely reject your proposal, even it looks good 🚮
- 👩🔬 Get your hands dirty.
- We are curious about your programming skills 🚀
- Your application will be much stronger if you fix Octave bugs or submit patches before or during the application period.
- You can take a look at the short projects for some simple bugs to start with.
- Use Octave!
- If you come across something that does not work the way you like ➡️ try to fix that 🔧
- Or if you find a missing function ➡️ try to implement it.
- We are curious about your programming skills 🚀
- 📝💡 Tell us what you are going to do.
- Do not write just to say what project you're interested in. Be specific about what you are going to do, include links 🔗, show us you know what you are talking about 💡, and ask many smart questions 🤓
- Remember, we are volunteer developers and not your boss 🙂
- 📔 Prepare your proposal with us.
- Try to show us as early as possible a draft of your proposal 📑
- If we see your proposal for the first time after the application deadline, it might easily contain some paragraphs not fully clear to us. Ongoing interaction will give us more confidence that you are capable of working on your project 🙂👍
- Then submit the proposal following the applicable rules, e.g. for GSoC. 📨
How do we judge your application?
Depending on the mentors and SoC program there are varieties, but typically the main factors considered would be:
- You have demonstrated interest in Octave and an ability to make substantial modifications to Octave
- The most important thing is that you've contributed some interesting code samples to judge your skills. It's OK during the application period to ask for help on how to format these code samples, which normally are Mercurial patches.
- You showed understanding of your topic
- Your proposal should make it clear that you're reasonably well versed in the subject area and won't need all summer just to read up on it.
- Well thought out, adequately detailed, realistic project plan
- "I'm good at this, so trust me" isn't enough. In your proposal, you should describe which algorithms you'll use and how you'll integrate with existing Octave code. You should also prepare a project timeline and goals for the midterm and final evaluations.
What you should know about Octave
GNU Octave is mostly written in C++ and its own scripting language that is mostly compatible with Matlab. There are bits and pieces of Fortran, Perl, C, awk, and Unix shell scripts here and there. In addition to being familiar with C++ and Octave's scripting language, you as successful applicant will be familiar with or able to quickly learn about Octave's infrastructure. You can't spend the whole summer learning how to build Octave or prepare a changeset and still successfully complete your project 😇
You should know:
- How to build Octave from its source code using the GNU build system.
- Read in this wiki: Developer FAQ, Building
- Tools to know: gcc, make
- How to submit patches (changesets).
- Read in this wiki: Contribution guidelines, Mercurial
- Tools to know: Mercurial (hg), git
Suggested projects
The following suggested projects are distilled from the Projects page for the benefit of potential SoC participants. You can also look at our completed past projects, or the current Octave Development Roadmap for more inspiration.
Adding more Classification classes and implementing missing methods in statistics package
Although a ClassificationKNN class was added in the latest statistics release (1.6.1), it still lacks several methods (only `predict` is available at the moment). This GSoC project aims at implementing more methods, such as crossval, cvloss, lime, loss, margin, partialDependence, plotPartialDependence, etc., as well as adding more classdefs related to classification classes, such as ClassificationGAM, ClassificationDiscriminant, ClassificationSVM, ClassificationNeuralNetwork, ClassificationNaiveBayes, etc. The statistics package, although heavily developed during the past years, still lacks a lot of classdef functionality. The scope is to implement classification class def objects and their relevant methods in a MATLAB compatible way.
- Project size [?] and Difficulty
- ~350 hours (hard)
- Required skills
- Octave, classdef, good knowledge of statistical methods
- Potential mentors
Custom re-implementation of the texi2html (v.1.82) command line tool
Implement a compiled .oct function to relax the dependency of the pkg-octave-doc package on texi2html (v.1.82) command line tool, which is no longer maintained or further developed but also not readily available to all linux distributions. The idea is to have a `texi2html` function within the pkg-octave-doc package that will replace the functionality of the texi2html (v.1.82) command line tool. This will also help improve the speed of pkg-octave-doc processing large packages, which contain specific tags (such as @math) which are currently handled within Octave code.
- Project size [?] and Difficulty
- ~350 hours (hard)
- Required skills
- Perl, C++, Octave, Texinfo, HTML
- Potential mentors
Project sizes
Since GSoC 2022 there exist two project sizes[1][2]:
- ~175 hours (~12 weeks, Jun 13 - Sept 12)
- ~350 hours (~22 weeks, Jun 13 - Nov 21)