GSoC overview

Line 1: Line 1:
'''Google Summer of Code 2013'''
'''Google Summer of Code 2013'''
-
During the [http://www.google-melange.com/gsoc/homepage/google/gsoc2013|Google Summer of Code] google will pay students to participate in open source projects - see the link for additional details.
+
During the [http://www.google-melange.com/gsoc/homepage/google/gsoc2013|Google Summer of Code] google will pay students to participate in open source projects - see the link for additional details. Your work will be released under an open source license, in case of STK that will be GPL 3.0. Make especially sure that you fulfill [http://www.google-melange.com/gsoc/document/show/gsoc_program/google/gsoc2013/help_page#1._Are_there_any_age_restrictions_on|GSoC's eligibility criteria.
For the first time SuperTuxKart will try to participate, i.e. become a mentoring organisation. That means (if we get accepted) that students can work on SuperTuxKart and receive money for it. They will be mentored by one of our experienced developer, and get some good work experience to start their career. Note that while SuperTuxKart is a game appealing to younger audiences, the code base is rather complicated, and our suggested tasks will certainly challenge students.
For the first time SuperTuxKart will try to participate, i.e. become a mentoring organisation. That means (if we get accepted) that students can work on SuperTuxKart and receive money for it. They will be mentored by one of our experienced developer, and get some good work experience to start their career. Note that while SuperTuxKart is a game appealing to younger audiences, the code base is rather complicated, and our suggested tasks will certainly challenge students.
Line 7: Line 7:
'''Sounds great - What should I do? '''
'''Sounds great - What should I do? '''
-
First of all make sure to have played STK, and have a look at our  
+
First of all make sure to have played STK, and have a look at our [http://supertuxkart.sourceforge.net/Milestones|milestones] page to see where we want to go. For any further steps you need at least some basic familiarity with SVN (if you don't have SVN experience, the [http://svnbook.red-bean.com|Version Control with Subversion] book is a good start).
 +
Then download and compile STK, instructions for this can be found [http://supertuxkart.sourceforge.net/Installation#Build_from_source|here]. You can find guides for compiling from source on all major platforms on the same website.
-
'''About'''
+
Have a look at our [http://supertuxkart.sourceforge.net/Coding_Style|coding style] and study our code, best using the [http://supertuxkart.sourceforge.net/doxygen/?title=doxygen|doxygen] pages. Note that the online version is updated irregularly, so best create your own documentation (just start doxygen in the src directory).
-
 
+
Even if you should have your own idea, please check out [http://supertuxkart.sourceforge.net/GSoC_ideas|idea] list first.
-
SuperTuxKart is applying for Google Summer of Code [http://www.google-melange.com/gsoc/homepage/google/gsoc2013] this year. This page will guide you through applying to work on SuperTuxKart.
+
-
 
+
-
SuperTuxKart is a free 3d kart racing game; we want to make the game fun more than we want to make it realistic. You can play with up to 4 friends on one PC, racing against each other or just try to beat the computer.
+
-
 
+
-
 
+
-
 
+
-
'''Obtaining the source code'''
+
-
 
+
-
The first step is to download the latest source code from SVN and compile it. Note that basic familiarity with SVN is recommended (you should at least be able to make a patch file from your local modifications). Head over to http://supertuxkart.sourceforge.net/Installation#Build_from_source to learn how to obtain the source code. You can find guides for compiling from source on all major platforms on the same website.
+
-
 
+
Line 27: Line 18:
The core team typically communicates over IRC and mailing lists. On IRC, we can be found on channel #stk on freenode. We are typically most active on week days from approximately 16:00 to 22:00, GMT -5 time. It is recommended to drop by our channel and idle by to see how things work, and discuss your application.
The core team typically communicates over IRC and mailing lists. On IRC, we can be found on channel #stk on freenode. We are typically most active on week days from approximately 16:00 to 22:00, GMT -5 time. It is recommended to drop by our channel and idle by to see how things work, and discuss your application.
-
It is also recommended to subscribe to the supertuxkart-devel mailing list [https://sourceforge.net/mailarchive/forum.php?forum_name=supertuxkart-devel&source=navbar] and to post a message introducing yourself and your project. Discussing the project with one of the core team members will significantly increase the changes of your application to be accepted.
+
It is also recommended to subscribe to the supertuxkart-devel mailing list [https://sourceforge.net/mailarchive/forum.php?forum_name=supertuxkart-devel&source=navbar] and to post a message introducing yourself and your project. Discussing the project with one of the core team members will significantly increase the changes of your application to be accepted.  
Line 33: Line 24:
'''Code and tickets'''
'''Code and tickets'''
-
The main prerequisite for working on SuperTuxKart is good C++ knowledge. You will also want to get familiar with our bug tracker [https://sourceforge.net/apps/trac/supertuxkart/]. Submitting a patch against a simple bug or two is a good way to get started with development and will increase your chances of being selected. Our code style guidelines can be found at [http://supertuxkart.sourceforge.net/Coding_Style]. Note that working for SuperTuxKart implies that you are willing to release code you write under the GPL license.
+
The main prerequisite for working on SuperTuxKart is good C++ knowledge. You will also want to get familiar with our bug tracker [https://sourceforge.net/apps/trac/supertuxkart/]. You do need a sourceforge account in order to submit a ticket. For a successful proposal we expect you to supply at least one patch beforehand so that we can have a look at your coding and commenting style. Either pick one of the existing tickets, or create your own ticket. In any case, please discuss the ticket with us first, some tickets might sound very simple but could be a lot of work for a proper implementation. While STK's documentation is rather good and extensive, we always welcome patches to improve this, and fix [http://supertuxkart.sourceforge.net/Coding_Style|coding style issues].  
-
 
+

Revision as of 10:47, 11 March 2013

Google Summer of Code 2013 During the Summer of Code google will pay students to participate in open source projects - see the link for additional details. Your work will be released under an open source license, in case of STK that will be GPL 3.0. Make especially sure that you fulfill [http://www.google-melange.com/gsoc/document/show/gsoc_program/google/gsoc2013/help_page#1._Are_there_any_age_restrictions_on|GSoC's eligibility criteria.

For the first time SuperTuxKart will try to participate, i.e. become a mentoring organisation. That means (if we get accepted) that students can work on SuperTuxKart and receive money for it. They will be mentored by one of our experienced developer, and get some good work experience to start their career. Note that while SuperTuxKart is a game appealing to younger audiences, the code base is rather complicated, and our suggested tasks will certainly challenge students.

Our list of ideas or suggestions is online [1]. Be aware that this is just a list of suggestions, and that students are welcome to apply with their own ideas. However the number of experienced mentors is somewhat limited, and our list of ideas was chosen since those tasks would be most beneficial for the development of SuperTuxKart. If you apply with your own idea, please make sure to discuss this with us beforehand.

Sounds great - What should I do? First of all make sure to have played STK, and have a look at our [2] page to see where we want to go. For any further steps you need at least some basic familiarity with SVN (if you don't have SVN experience, the Control with Subversion book is a good start).

Then download and compile STK, instructions for this can be found [3]. You can find guides for compiling from source on all major platforms on the same website.

Have a look at our style and study our code, best using the [4] pages. Note that the online version is updated irregularly, so best create your own documentation (just start doxygen in the src directory). Even if you should have your own idea, please check out [5] list first.


Getting in touch

The core team typically communicates over IRC and mailing lists. On IRC, we can be found on channel #stk on freenode. We are typically most active on week days from approximately 16:00 to 22:00, GMT -5 time. It is recommended to drop by our channel and idle by to see how things work, and discuss your application. It is also recommended to subscribe to the supertuxkart-devel mailing list [6] and to post a message introducing yourself and your project. Discussing the project with one of the core team members will significantly increase the changes of your application to be accepted.


Code and tickets

The main prerequisite for working on SuperTuxKart is good C++ knowledge. You will also want to get familiar with our bug tracker [7]. You do need a sourceforge account in order to submit a ticket. For a successful proposal we expect you to supply at least one patch beforehand so that we can have a look at your coding and commenting style. Either pick one of the existing tickets, or create your own ticket. In any case, please discuss the ticket with us first, some tickets might sound very simple but could be a lot of work for a proper implementation. While STK's documentation is rather good and extensive, we always welcome patches to improve this, and fix style issues.


Required information

Applications should contain at least the following points of information :

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

User Tools