Difference between revisions of "Summer of Code/Checklist"
From BRL-CAD
(expand the checklist into four main sections, one during the application period, then before coding begins, and then while coding, then after it's all done) |
|||
| Line 1: | Line 1: | ||
| − | = | + | = GSoC Checklist = |
| − | Before the summer begins, there are several things that students should do to become familiarized with BRL-CAD development. Below is a checklist of things each | + | Before the summer coding begins, there are several things that students should do to become familiarized with BRL-CAD development. Below is a checklist of things each student should complete before the official GSoC coding start date. Some items on the checklist should occur during the application submission process while others need to occur before it's time to start coding. |
| − | * | + | == In order to apply == |
| − | * | + | |
| − | * | + | * Review the [[Google_Summer_of_Code/Project_Ideas|Project Ideas]] |
| + | * Consider the [[Google_Summer_of_Code/Application_Guidelines|Application Guidelines]] | ||
| + | * Understand the [[Google Summer of Code/Acceptance|Acceptance Requirements]] | ||
* Join the [http://irc.brlcad.org #brlcad IRC channel] and introduce yourself | * Join the [http://irc.brlcad.org #brlcad IRC channel] and introduce yourself | ||
* Join the [http://sourceforge.net/mailarchive/forum.php?forum_name=brlcad-devel brlcad-devel mailing list] and introduce yourself | * Join the [http://sourceforge.net/mailarchive/forum.php?forum_name=brlcad-devel brlcad-devel mailing list] and introduce yourself | ||
| + | * Prepare your application | ||
| + | * Discuss your application with the mentors | ||
| + | ** ''(optional) Post your application to your wiki user page (/wiki/User:username)'' | ||
| + | ** ''(optional) Share and discuss your application on the mailing list'' | ||
| + | * '''[http://sourceforge.net/tracker/?func=add&group_id=105292&atid=640804 Submit a patch] if you don't have commit access''' | ||
| + | * [http://socghop.appspot.com/ Submit your application] | ||
| + | |||
| + | == Prior to the starting date == | ||
| + | |||
| + | * Agree to the [[Google_Summer_of_Code/Acceptance|acceptance requirements]] | ||
| + | * Read our [[Google_Summer_of_Code/Expectations|participation expectations]] | ||
| + | * Read the [http://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk/HACKING development guidelines] | ||
* Familiarize yourself with Subversion | * Familiarize yourself with Subversion | ||
| − | * Compile and run BRL-CAD from source | + | * '''''Compile and run BRL-CAD from source''''' |
* Familiarize yourself with BRL-CAD's on-line resources | * Familiarize yourself with BRL-CAD's on-line resources | ||
** http://brlcad.org | ** http://brlcad.org | ||
| Line 16: | Line 30: | ||
** http://brlcad.org/d/documentation | ** http://brlcad.org/d/documentation | ||
** http://sf.net/projects/brlcad | ** http://sf.net/projects/brlcad | ||
| − | * Document your | + | * Create a Sourceforge and brlcad.org wiki account |
| − | * Discuss your | + | * Publish a development plan to the wiki |
| − | + | ** Document a list of 3 to 10 development milestones | |
| − | + | ** Document your plan on the Wiki as a design document | |
| + | * Discuss your plan via irc and/or on the mailing list | ||
* Set up an interaction schedule with your mentor | * Set up an interaction schedule with your mentor | ||
| − | + | ||
| + | == Once coding begins == | ||
* '''''[http://sourceforge.net/tracker/?group_id=105292&atid=640804 Post patches] until you get commit access''''' | * '''''[http://sourceforge.net/tracker/?group_id=105292&atid=640804 Post patches] until you get commit access''''' | ||
| + | * Write maintainable, portable, complete code | ||
| + | * Keep a '''daily''' log of your activities online somewhere (wiki user page is great for this) | ||
| + | * Report your progress periodically to the mailing list | ||
| + | |||
| + | == After GSoC ends == | ||
| + | * Provide a final report on your project progress to the mailing list | ||
| + | * '''Continue working on BRL-CAD :-)''' | ||
Revision as of 19:28, 30 March 2009
Contents
GSoC Checklist
Before the summer coding begins, there are several things that students should do to become familiarized with BRL-CAD development. Below is a checklist of things each student should complete before the official GSoC coding start date. Some items on the checklist should occur during the application submission process while others need to occur before it's time to start coding.
In order to apply
- Review the Project Ideas
- Consider the Application Guidelines
- Understand the Acceptance Requirements
- Join the #brlcad IRC channel and introduce yourself
- Join the brlcad-devel mailing list and introduce yourself
- Prepare your application
- Discuss your application with the mentors
- (optional) Post your application to your wiki user page (/wiki/User:username)
- (optional) Share and discuss your application on the mailing list
- Submit a patch if you don't have commit access
- Submit your application
Prior to the starting date
- Agree to the acceptance requirements
- Read our participation expectations
- Read the development guidelines
- Familiarize yourself with Subversion
- Compile and run BRL-CAD from source
- Familiarize yourself with BRL-CAD's on-line resources
- Create a Sourceforge and brlcad.org wiki account
- Publish a development plan to the wiki
- Document a list of 3 to 10 development milestones
- Document your plan on the Wiki as a design document
- Discuss your plan via irc and/or on the mailing list
- Set up an interaction schedule with your mentor
Once coding begins
- Post patches until you get commit access
- Write maintainable, portable, complete code
- Keep a daily log of your activities online somewhere (wiki user page is great for this)
- Report your progress periodically to the mailing list
After GSoC ends
- Provide a final report on your project progress to the mailing list
- Continue working on BRL-CAD :-)
