Difference between revisions of "Summer of Code/Project Rules"

From ScummVM :: Wiki
Jump to navigation Jump to search
m (More grammar fixes)
(Order and group content, clarify some stuff, elaborate on other)
Line 2: Line 2:
  
 
These rules exist to make the program as rewarding and problem free for all concerned and are designed to help you get the most out of GSoC.
 
These rules exist to make the program as rewarding and problem free for all concerned and are designed to help you get the most out of GSoC.
 +
==Before you apply...==
 +
* ... take into account that '''Google Summer of Code is a full time job'''. If you consider getting an additional part time job, have extensive exams or an extended vacation during the program, you likely should not apply.
 +
** ''Experience in previous years' GSoC has shown us that students with extensive extra fixed commitments during the GSoC coding phase tend to really struggle to meet their goals.''
  
* Google Summer of Code is a '''full time job'''. If you consider getting an additional part time job, have extensive exams or an extended vacation during the program please do not apply.
+
==Before you are accepted...==
** ''Experience in previous years' GSoC has shown us that students with extensive extra fixed commitments during the GSoC coding phase tend to really struggle to meet their goals.''
+
* ...prepare a '''comprehensive and detailed plan for all 12 weeks of your project'''. Include risk mitigation (you might fall ill, a phase in your project be more complicated than anticipated, etc.) and any existing commitments.
* We require a comprehensive and detailed plan for all 12 weeks of your project. Include risk mitigation and any existing commitments.
+
** ''This plan will help you and us to decide at any time during the project how well you are progressing. It forces you to think about what you need to do beforehand, and provides a guideline for you while GSoC is progressing. Maybe it sounds like a tedious task to you, but experience shows that you may benefit tremendously from this, if done it right.''
** ''This plan provides one of the key markers we will use to judge the progress with your project.''
+
* ...you are expected to '''submit a patch''' against our Subversion source code using our patch tracker. Fix some known bug, extends functionality in some way, or provide a start for the work you are applying for.
* We require each student to communicate with their mentor every second day. If you fail to do that for longer than 3 days without arrangement, you will fail the program.
+
** ''This is the basic entry bar to ensure that applicants are familiar enough with the code and concepts in ScummVM to submit a patch. I.e., whether you manage to checkout the source, compile it, make a change, and use our patch tracker. Don't worry, though: It does not have to be anything complex, and you are highly welcome and even expected to ask us for help and guidance. In fact, finding out whether you communicate well with us and are willing to ask questions and learn is part of the test.''
 +
 
 +
==During GSoC...==
 +
* ... we require you to '''communicate with your mentor''' every second day. If you fail to do that for longer than three days without arrangement, you will fail the program.
 
** ''Communication is key to a successful GSoC project and experience has shown that students that do not check in with their mentors (and the wider community) tend to struggle and produce weaker outputs.''
 
** ''Communication is key to a successful GSoC project and experience has shown that students that do not check in with their mentors (and the wider community) tend to struggle and produce weaker outputs.''
* Students are expected to submit a patch with or before their application which fixes some known bug, extends functionality in some way, or is a start of their work that they are applying for.
+
* ... we ask you to '''keep a weblog''' (BLOG) with posts on a weekly or more frequent basis detailing their progress and experiences with their project/GSoC.  
** ''This is the basic entry bar to ensure that applicants are familiar enough with the code and concepts in ScummVM to submit a patch. It does not have to be a complex patch and we will willingly provide help and guidance.''
+
** ''This provides a valuable avenue for feedback and helps involvement of the wider community. It also helps you to sort your thoughts and determine your own progress. Note that the blogs will be aggregated onto ScummVM's Planet site so language and tone should be set accordingly.''
* We ask students to keep a weblog (BLOG) with posts on a weekly or more frequent basis detailing their progress and experiences with their project/GSoC.  
+
* ... your code must comply to our '''[[Code Formatting Conventions]]'''.
** ''This provides a valuable avenue for feedback and helps involvement of the wider community. Note that the blogs will be aggregated onto ScummVM's Planet site so language and tone should be set accordingly.''
 
* Stick to our [[Code Formatting Conventions]].
 
 
** ''The formatting conventions are one of the main ways we keep consistency with such a large codebase. We want students to work towards their code being incorporated into mainline ScummVM and this is a prerequisite.''
 
** ''The formatting conventions are one of the main ways we keep consistency with such a large codebase. We want students to work towards their code being incorporated into mainline ScummVM and this is a prerequisite.''
* Checked in code has to be always at least ''compilable''.
+
* ... you should at the very least verify that your '''code is compilable''' before you commit it.
 
** ''Checked in code does not have to be feature complete or anything like that but it should at least compile at all times. Mentors regularly review students' code and having to speed hours making the code compile is a very thankless task ;) when that time could be better spent on review.''
 
** ''Checked in code does not have to be feature complete or anything like that but it should at least compile at all times. Mentors regularly review students' code and having to speed hours making the code compile is a very thankless task ;) when that time could be better spent on review.''
* Commit often, commit early.
+
* ... we expect you to '''commit often, commit early'''.
** ''We judge students' code based on what is checked in and take the view that 'if it's not checked in it does not exist' for the purposes of GSoC reviews.''
+
** ''We judge students' code based on what is checked in and take the view that 'if it's not checked in it does not exist' for the purposes of GSoC reviews. Don't be shy about this. You may feel your code is not 'good enough', but the best way to learn whether it actually is good or not, and also to get valuable hints on how to improve it, is to show it to us. Trust us, we will give you constructive feedback and won't bash you for what you produce.''

Revision as of 00:19, 10 March 2009

Here you will find several important rules which you have to agree to follow in order to be eligible to apply as a student for the ScummVM project.

These rules exist to make the program as rewarding and problem free for all concerned and are designed to help you get the most out of GSoC.

Before you apply...

  • ... take into account that Google Summer of Code is a full time job. If you consider getting an additional part time job, have extensive exams or an extended vacation during the program, you likely should not apply.
    • Experience in previous years' GSoC has shown us that students with extensive extra fixed commitments during the GSoC coding phase tend to really struggle to meet their goals.

Before you are accepted...

  • ...prepare a comprehensive and detailed plan for all 12 weeks of your project. Include risk mitigation (you might fall ill, a phase in your project be more complicated than anticipated, etc.) and any existing commitments.
    • This plan will help you and us to decide at any time during the project how well you are progressing. It forces you to think about what you need to do beforehand, and provides a guideline for you while GSoC is progressing. Maybe it sounds like a tedious task to you, but experience shows that you may benefit tremendously from this, if done it right.
  • ...you are expected to submit a patch against our Subversion source code using our patch tracker. Fix some known bug, extends functionality in some way, or provide a start for the work you are applying for.
    • This is the basic entry bar to ensure that applicants are familiar enough with the code and concepts in ScummVM to submit a patch. I.e., whether you manage to checkout the source, compile it, make a change, and use our patch tracker. Don't worry, though: It does not have to be anything complex, and you are highly welcome and even expected to ask us for help and guidance. In fact, finding out whether you communicate well with us and are willing to ask questions and learn is part of the test.

During GSoC...

  • ... we require you to communicate with your mentor every second day. If you fail to do that for longer than three days without arrangement, you will fail the program.
    • Communication is key to a successful GSoC project and experience has shown that students that do not check in with their mentors (and the wider community) tend to struggle and produce weaker outputs.
  • ... we ask you to keep a weblog (BLOG) with posts on a weekly or more frequent basis detailing their progress and experiences with their project/GSoC.
    • This provides a valuable avenue for feedback and helps involvement of the wider community. It also helps you to sort your thoughts and determine your own progress. Note that the blogs will be aggregated onto ScummVM's Planet site so language and tone should be set accordingly.
  • ... your code must comply to our Code Formatting Conventions.
    • The formatting conventions are one of the main ways we keep consistency with such a large codebase. We want students to work towards their code being incorporated into mainline ScummVM and this is a prerequisite.
  • ... you should at the very least verify that your code is compilable before you commit it.
    • Checked in code does not have to be feature complete or anything like that but it should at least compile at all times. Mentors regularly review students' code and having to speed hours making the code compile is a very thankless task ;) when that time could be better spent on review.
  • ... we expect you to commit often, commit early.
    • We judge students' code based on what is checked in and take the view that 'if it's not checked in it does not exist' for the purposes of GSoC reviews. Don't be shy about this. You may feel your code is not 'good enough', but the best way to learn whether it actually is good or not, and also to get valuable hints on how to improve it, is to show it to us. Trust us, we will give you constructive feedback and won't bash you for what you produce.