114
edits
Difference between revisions of "Summer of Code/Project Rules"
Jump to navigation
Jump to search
m
More grammar fixes
m (Some more grammar/spelling fixes) |
m (More grammar fixes) |
||
| Line 9: | Line 9: | ||
* 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. | * 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. | ||
** ''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 | * 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. | ||
** ''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 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.'' | ||
* We ask students to keep a weblog (BLOG) with posts on a weekly or more frequent basis detailing | * 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. | ||
** ''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.'' | ** ''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]]. | * 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 | ** ''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''. | * Checked in code has to be always at least ''compilable''. | ||
** ''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. | * Commit often, commit early. | ||
** ''We judge students code based on what is checked in and take the view that 'if | ** ''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.'' | ||