Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
community:gsoc:gsoc2011_student_guidelines [2011/03/02 04:04] bitner |
community:gsoc:gsoc2011_student_guidelines [2011/03/12 16:29] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Guidelines for Students Participating in Google Summer of Code 2011 for Sahana ====== | + | ====== Guidelines for Students Participating in GSOC 2011 for SSF ====== |
+ | |||
+ | ===== Overview ===== | ||
+ | * Prior GSOC Students with the Sahana | ||
+ | * Students must submit a bug fix for the project first. (Please engage with proposed mentors to identify an appropriate bug that will demonstrate your skills and capabilities). | ||
+ | * Students should get involved with projects now | ||
+ | * Our priorities and [[community: | ||
+ | |||
+ | ===== Expectations ===== | ||
+ | |||
+ | ==== Coding ==== | ||
+ | |||
+ | It is expected that students will read and follow the developer guidelines for the project that they are working with.\\ | ||
+ | |||
+ | For Agasti (PHP): | ||
+ | * [[agasti: | ||
+ | * [[agasti: | ||
+ | * [[agasti: | ||
+ | * [[agasti: | ||
+ | For Eden (Python/ | ||
+ | * [[http:// | ||
+ | * [[http:// | ||
+ | |||
+ | ==== Communication ==== | ||
+ | * It is expected that students will report to the main Sahana discussion list (discuss@lists.sahanafoundation dot org) at the beginning of the project to introduce themselves and their project to the rest of the Sahana community. | ||
+ | * It is expected that students will report to the main Sahana discussion list at a minimum once every other week providing a summary of current activities with pointers to their work in the code and on the wiki. | ||
+ | * It is also advisable to keep all development related discussions on the developer' | ||
+ | * GSOC-related discussions should be prefaced with " | ||
+ | |||
+ | === IRC Channels === | ||
+ | We maintain and monitor the followin IRC Channels on freenode. | ||
+ | * #Sahana - main disussion channel | ||
+ | * # | ||
+ | * # | ||
+ | * # | ||
+ | All channels are logged. | ||
+ | |||
+ | === Mailing Lists === | ||
+ | We maintain several e-mail discussion lists. | ||
+ | * Join the [[https:// | ||
+ | * Join the [[https:// | ||
+ | * Join the [[http:// | ||
+ | |||
+ | |||
+ | ==== Contributor License Agreement ==== | ||
+ | |||
+ | In keeping with Sahana Software Foundation policy, all accepted students must sign and return a [[foundation: | ||
+ | |||
+ | ==== Documentation ==== | ||
+ | * It is expected that students will document all of their work in an appropriate place on the Sahana wiki (mentors will help with where to put things and with wiki access). | ||
+ | |||
+ | ==== Work Load ==== | ||
+ | * It is expected that students will treat this as a full time job (This means approximately 40 hours per week). Students should disclose any other commitments to other jobs, internships, | ||
===== Application Process ===== | ===== Application Process ===== | ||
==== Application Template ==== | ==== Application Template ==== | ||
Line 40: | Line 93: | ||
These should be broken down into the following stages. | These should be broken down into the following stages. | ||
- Work already undertaken - What research have you undertaken in this area in advance? (these can just be bullet points and are not required to follow the SMART methodology) | - Work already undertaken - What research have you undertaken in this area in advance? (these can just be bullet points and are not required to follow the SMART methodology) | ||
- | - First trimester (26 April - 23 May) - identify the SMART goals you have for the community bonding period. Most of these are likely to revolve around further scoping of the project with the community, engaging with the community, and updating and finalizing the project plan. | + | - First trimester (25 April - 23 May) - identify the SMART goals you have for the community bonding period. Most of these are likely to revolve around further scoping of the project with the community, engaging with the community, and updating and finalizing the project plan. |
- | - Second trimester (24 May - 12 July) - identify the draft SMART goals you have for the first half of the project. These will be used to assess project process and form the basis for the mid-term evaluation. | + | - Second trimester (24 May - 11 July) - identify the draft SMART goals you have for the first half of the project. These will be used to assess project process and form the basis for the mid-term evaluation. |
- | - Third trimester (13 July - 9 August) - identify the draft SMART goals you have for the second half of the project. These will be used to assess the whole project and in conjunction with the mid-term goals, form the basis for the final evaluation. | + | - Third trimester (12 July - 15 August) - identify the draft SMART goals you have for the second half of the project. These will be used to assess the whole project and in conjunction with the mid-term goals, form the basis for the final evaluation. |
We recognize that the goals may change during the project, and the mentors will accept modifications to the goals at any time. For example, discussion during the community engagement stage may change the scope of the project, and the goals may need to be subsequently modified. As such, the goals are not hard-and-fast, | We recognize that the goals may change during the project, and the mentors will accept modifications to the goals at any time. For example, discussion during the community engagement stage may change the scope of the project, and the goals may need to be subsequently modified. As such, the goals are not hard-and-fast, | ||
Line 54: | Line 107: | ||
It is encouraged for students to communicate with the Sahana team members during the application process to help guide their applications. | It is encouraged for students to communicate with the Sahana team members during the application process to help guide their applications. | ||
Venues to discuss projects: | Venues to discuss projects: | ||
- | * [[https:// | + | * [[https:// |
* [[http:// | * [[http:// | ||
- | ===== Expectations ===== | + | If your questions are specific to a particular Sahana Project (Agasti or Eden), mentors may direct you to a more specific mailing list or IRC channel. You should not expect to use personal email or direct messaging to communicate with mentors. |
- | ==== Coding Standards ==== | ||
- | * It is expected that students read up on the developer guidelines from the project wiki beforehand to have an overview of the Sahana system | ||
- | For PHP: | ||
- | * [[dev:home| Dev Wiki]], especially the coding conventions & [[http:// | ||
- | For Python: | ||
- | * [[http:// | ||
- | |||
- | ==== Communication ==== | ||
- | * It is expected that students will report to the Sahana development mailing list at the beginning of the project to introduce themselves and their project to the rest of the Sahana community. | ||
- | * It is expected that students will report to the Sahana development mailing list at a minimum once every other week providing a summary of current activities with pointers to their work in the code and on the wiki. | ||
- | * It is also advisable to keep all development related discussions on the mailing lists so that other developers can provide feedback & suggestions on the ideas being worked out and for future archival purposes. | ||
- | ==== Documentation ==== | ||
- | * It is expected that students will document all of their work in an appropriate place on the Sahana wiki (mentors will help with where to put things and with wiki access). | ||
- | |||
- | ==== Work Load ==== | ||
- | * It is expected that students will treat this as a full time job. | ||