GSoC overview

(Required information)
(+github -dead link)
 
Line 24: Line 24:
The main prerequisite for working on SuperTuxKart is good C++ knowledge. You will also want to get familiar with our [https://github.com/supertuxkart/stk-code/issues?state=open bug tracker].
The main prerequisite for working on SuperTuxKart is good C++ knowledge. You will also want to get familiar with our [https://github.com/supertuxkart/stk-code/issues?state=open bug tracker].
-
At this stage you need a sourceforge account in order to submit a ticket. The chances of a proposal to be accepted can be increased if you submit a patch first. This allows us to evaluate your coding style, way of documenting etc.  Even if you don't find a ticket you want to work on (admittedly many of our tickets would require some work), feel free to open a ticket yourself, and submit a patch for it. One simple example would be to improve [[Coding_Style | coding style issues]] in a file, or improve documentation - there are still some older files which were not brought up-to-date with latest coding style changes. If you are looking for more of a challenge, try to implement an achievement. The achievement infrastructure is the result of the 2013 GSoC, and achievements will be contained in the next release of STK. So we are always looking for more achievements. Have a look at the files in src/achievements for more details. In any case, please discuss the ticket with us first, we can help in identifying tickets appropriate for your skill level.  
+
At this stage you need a github account in order to submit a ticket. The chances of a proposal to be accepted can be increased if you open a pull-request first. This allows us to evaluate your coding style, way of documenting etc.  Even if you don't find a ticket you want to work on (admittedly many of our tickets would require some work), feel free to open a ticket yourself, and submit a patch for it. One simple example would be to improve [[Coding_Style|coding style issues]] in a file, or improve documentation - there are still some older files which were not brought up-to-date with latest coding style changes. If you are looking for more of a challenge, try to implement an achievement. The achievement infrastructure is the result of the 2013 GSoC, and achievements will be contained in the next release of STK. So we are always looking for more achievements. Have a look at the files in src/achievements for more details. In any case, please discuss the ticket with us first, we can help in identifying tickets appropriate for your skill level.  
-
Any contributions to SuperTuxKart must be in clean and portable C++. They should also compile without any warnings. We don't expect that a student to be able to check his code on all supported platforms - our community will do this and fix any minor issues that should occur when using a different compiler. Please also have a look at some of our [[Portability_concerns | portability advise]].
+
Any contributions to SuperTuxKart must be in clean and portable C++. They should also compile without any warnings. We don't expect that a student to be able to check his code on all supported platforms - our community will do this and fix any minor issues that should occur when using a different compiler.
-
We have started to use travis-ci - which means that as soon as anything is committed to our GitHub repository, travis-ci will compile on linux and report any problems.
+
We have started to use travis-ci - which means that as soon as anything is committed to our GitHub repository, travis-ci will compile on linux and report any problems. You can also activate travis-ci for your own repository.
=== How to get prepared for submitting a proposal ===
=== How to get prepared for submitting a proposal ===
Line 61: Line 61:
* What platform do you usually work on?
* What platform do you usually work on?
* One-line project summary
* One-line project summary
-
* Detailed project description (a few paragraphs to one page)
+
* Detailed project description, analysis and implementation plan (suggested length: 2 to 5 pages)
* A rough roadmap and timeline of the planned development
* A rough roadmap and timeline of the planned development
** Before the actual programming start, we want to have a more detailed timeline, including milestones/deliverables
** Before the actual programming start, we want to have a more detailed timeline, including milestones/deliverables

Latest revision as of 08:48, 14 August 2014

Retrieved from "http://supertuxkart.sourceforge.net/GSoC_overview"

User Tools