Difference between revisions of "Summer of Code/Checklist"

(completely redo and revamp the checklist this year, more generalized, distinctly call out our collaborator resources where needed)
Line 1: Line 1:
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 start dateSome items on the checklist should occur during the application submission process while others need to occur before it's time to start coding.
+
Below is a checklist to help students get set up quicklyItems are categorized to help you prepare your application, get set up to work, and become familiarized with basic infrastructure.
  
= IN ORDER TO APPLY =
+
{| class="wikitable" style="width: 800px; padding: 8px; border: 1px solid #fff; text-align: left; background-color:#f7f7f7;"
 +
!colspan=5|<u>IN ORDER TO APPLY</u>
 +
|-
 +
| style="width: 3%; text-align:center; vertical-align:top;"|
 +
| colspan=4|
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">1</div>
 +
|colspan=4|Check out our [[Google_Summer_of_Code/Project_Ideas|Project Ideas]]
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">2</div>
 +
|colspan=4|Introduce yourself!  Don't be shy.<br>
 +
{|width=100% style="font-size:75%"
 +
| style="width: 25%; background-color: #eee; text-align:center;"| BRL-CAD
 +
| style="width: 25%; background-color: #eee; text-align:center;"| OpenSCAD
 +
| style="width: 25%; background-color: #eee; text-align:center;"| LibreCAD
 +
| style="width: 25%; background-color: #eee; text-align:center;"| STEPcode
 +
|-
 +
|style="text-align:left;"|E-Mail: [https://lists.sourceforge.net/lists/listinfo/brlcad-devel brlcad-devel]
 +
|style="text-align:left;"|E-Mail: [http://rocklinux.net/mailman/listinfo/openscad openscad]
 +
|style="text-align:left;"|E-Mail: [http://forum.librecad.org/LibreCAD-dev-f4361976.html LibreCAD-dev]
 +
|style="text-align:left;"|E-Mail: [https://groups.google.com/forum/?fromgroups#!forum/scl-dev scl-dev]
 +
|-
 +
|style="text-align:left;"|Chat: [irc://irc.freenode.net/#brlcad #brlcad]
 +
|style="text-align:left;"|Chat: [irc://irc.freenode.net/#openscad #openscad]
 +
|style="text-align:left;"|Chat: [irc://irc.freenode.net/#librecad #librecad]
 +
|style="text-align:left;"|Chat: [irc://irc.freenode.net/#stepcode #stepcode]
 +
|}
 +
See [[IRC]] if you've never used it before.  Ask specific questions and wait!  [http://webchat.freenode.net/ Web interface here].
  
# Review our [[Google_Summer_of_Code/Project_Ideas|Project Ideas]]
+
|-
# Follow our [[Summer_of_Code/Application_Guidelines|Application Guidelines]]
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px; height:25px; border:1px solid #333;">3</div>
# Understand your [[Summer_of_Code/Acceptance|Acceptance Requirements]]
+
|colspan=4|Begin your application, see [[Summer_of_Code/Application_Guidelines|our guidelines]]
# Join our [irc://irc.freenode.net/#brlcad #brlcad IRC channel] and introduce yourself (web interface [http://webchat.freenode.net/ here])
+
|-
# Join our [https://lists.sourceforge.net/lists/listinfo/brlcad-devel brlcad-devel mailing list] and introduce yourself
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px; height:25px; border:1px solid #333;">4</div>
# Discuss your application with our mentors (don't wait!)
+
|colspan=4|Discuss and share your project details (don't wait!)<br>
# Prepare your application
+
|-
# Discuss your application with the mentors some more :)
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px; height:25px; border:1px solid #333;">6</div>
## ''(optional) Post your application to your wiki user page (/wiki/User:username)''
+
|colspan=4|See [[Google_Summer_of_Code/2013|some examples]] of awesome proposals, add detail to yours ''':)'''
## ''(optional) Share and discuss your application on the mailing list''
+
|-
# (optional but recommended) '''[http://sourceforge.net/tracker/?func=add&group_id=105292&atid=640804 Submit a useful patch]'''  (be awesome)
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px; height:25px; border:1px solid #333;">7</div>
# Submit your application
+
|colspan=4|'''[http://www.google-melange.com/ Submit] your application!'''
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px; height:25px; border:1px solid #333;">*</div>
 +
|colspan=4|Make a useful patch  ''(be awesome)''<br><div style="font-size:50%">(optional but recommended)</div>
 +
|-
 +
|colspan=5|<br>
 +
|-
 +
!colspan=5|<u>IF YOU GET SELECTED, BEFORE CODING BEGINS</u>
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;"></div>
 +
|colspan=4|Agree to the [[Summer_of_Code/Acceptance|acceptance requirements]]<br><div style="font-size:50%">(you must do this in writing)</div>
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;"></div>
 +
|colspan=4|Read our [[Summer_of_Code/Expectations|participation expectations]]<br><div style="font-size:50%">(read it ALL, we will quiz you later)</div>
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;"></div>
 +
|colspan=4|Set up an interaction schedule with your mentors<br><div style="font-size:50%">(at least weekly)</div>
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;"></div>
 +
|colspan=4|Fill out [http://brlcad.org/wiki/Google_Summer_of_Code/2014 your profile]<div style="font-size:50%">(one sentence summary, your name, link to proposal, dev log, and melange page)</div>
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;"></div>
 +
|colspan=4|Get familiarized with web resources
 +
{|width=100% style="font-size:75%"
 +
| style="width: 25%; background-color: #eee; text-align:center;"| BRL-CAD
 +
| style="width: 25%; background-color: #eee; text-align:center;"| OpenSCAD
 +
| style="width: 25%; background-color: #eee; text-align:center;"| LibreCAD
 +
| style="width: 25%; background-color: #eee; text-align:center;"| STEPcode
 +
|-
 +
|style="text-align:left; vertical-align:top;"|[http://brlcad.org/ Web]<br>[http://brlcad.org/wiki/ Wiki Docs]<br>[http://sf.net/projects/brlcad SF Project Site]<br>[http://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk/HACKING Dev Rules]<br>[[Patches]]
 +
|style="text-align:left; vertical-align:top;"|[http://www.openscad.org/ Web]
 +
|style="text-align:left; vertical-align:top;"|[http://librecad.org/ Web]
 +
|style="text-align:left; vertical-align:top;"|[http://stepcode.org/ Web]
 +
|}
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;"></div>
 +
|colspan=4|Post your proposal online<br><div style="font-size:50%">(on our wiki is fine)</div>
 +
* Describe your project plan
 +
* Document a list of 3 to 10 milestones
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;"></div>
 +
|colspan=4|Announce your plan via Chat and/or E-mail<br><div style="font-size:50%">(discuss and make adjustments)</div>
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;"></div>
 +
|colspan=4|Download the source code, get set up<br><div style="font-size:50%">(compile, install, run)</div>
 +
{|width=100% style="font-size:75%"
 +
| style="width: 25%; background-color: #eee; text-align:center;"| BRL-CAD
 +
| style="width: 25%; background-color: #eee; text-align:center;"| OpenSCAD
 +
| style="width: 25%; background-color: #eee; text-align:center;"| LibreCAD
 +
| style="width: 25%; background-color: #eee; text-align:center;"| STEPcode
 +
|-
 +
|style="text-align:left; vertical-align:top;"|[http://sourceforge.net/p/brlcad/code/HEAD/tree/ Sources]<br>[https://github.com/BRL-CAD/web Web Sources]<br>[[Compiling]]
 +
|style="text-align:left; vertical-align:top;"|[https://github.com/openscad/openscad Sources]<br>[http://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Building_OpenSCAD_from_Sources Compiling]
 +
|style="text-align:left; vertical-align:top;"|[https://github.com/LibreCAD/LibreCAD Sources]<br>[http://librecad.org/cms/home/from-source/linux.html Compiling]
 +
|style="text-align:left; vertical-align:top;"|[https://github.com/stepcode/stepcode Sources]<br>[https://github.com/stepcode/stepcode/wiki/Compiling-SCL Compiling]
 +
|}
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;"></div>
 +
|colspan=4|Submit patches to get familiarized with code<br><div style="font-size:50%">(find small tasks [http://www.google-melange.com/gci/org/google/gci2013/brlcad like these])</div>
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;"></div>
 +
|colspan=4|A few more things...
 +
{|width=100% style="font-size:75%"
 +
| style="width: 25%; background-color: #eee; text-align:center;"| BRL-CAD
 +
| style="width: 25%; background-color: #eee; text-align:center;"| OpenSCAD
 +
| style="width: 25%; background-color: #eee; text-align:center;"| LibreCAD
 +
| style="width: 25%; background-color: #eee; text-align:center;"| STEPcode
 +
|-
 +
|style="text-align:left; vertical-align:top;"|Create a Sourceforge and brlcad.org wiki account.<br>Make ''perfect'' patches to obtain commit access.
 +
|style="text-align:left; vertical-align:top;"|
 +
|style="text-align:left; vertical-align:top;"|
 +
|style="text-align:left; vertical-align:top;"|
 +
|}
 +
|-
 +
|colspan=5|<br>
 +
|-
 +
!colspan=5|<u>ONCE CODING BEGINS</u>
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;"></div>
 +
|colspan=4|Write maintainable, portable, complete code
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;"></div>
 +
|colspan=4|Keep a '''daily''' log of your activities online somewhere (wiki user page is great for this)
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;"></div>
 +
|colspan=4|Provide a midterm report on your project progress to the mailing list
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;"></div>
 +
|colspan=4|Stay motivated, engage other devs, allocate time for discussions
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;"></div>
 +
|colspan=4|Provide a final report on your project progress to the mailing list
 +
|-
 +
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;"></div>
 +
|colspan=4|'''Keep working on BRL-CAD, OpenSCAD, LibreCAD, or STEPcode :-)'''
 +
|}
  
= IF YOU ARE ACCEPTED =
 
 
* Agree to the [[Summer_of_Code/Acceptance|acceptance requirements]]
 
* Read our [[Summer_of_Code/Expectations|participation expectations]]
 
* Read our [http://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk/HACKING development guidelines]
 
* Familiarize yourself with Subversion
 
* '''''Compile and run BRL-CAD from source'''''
 
* Familiarize yourself with BRL-CAD's on-line resources
 
** http://brlcad.org
 
** http://brlcad.org/wiki
 
** http://brlcad.org/gallery
 
** http://brlcad.org/d/documentation
 
** http://sf.net/projects/brlcad
 
* 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
 
* Become a productive developer
 
** '''''[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
 
* Provide a final report on your project progress to the mailing list
 
* '''Continue working on BRL-CAD  :-)'''
 
  
 
[[category:Summer of Code]]
 
[[category:Summer of Code]]

Revision as of 00:15, 11 March 2014

Below is a checklist to help students get set up quickly. Items are categorized to help you prepare your application, get set up to work, and become familiarized with basic infrastructure.

IN ORDER TO APPLY
1
Check out our Project Ideas
2
Introduce yourself! Don't be shy.
BRL-CAD OpenSCAD LibreCAD STEPcode
E-Mail: brlcad-devel E-Mail: openscad E-Mail: LibreCAD-dev E-Mail: scl-dev
Chat: #brlcad Chat: #openscad Chat: #librecad Chat: #stepcode

See IRC if you've never used it before. Ask specific questions and wait! Web interface here.

3
Begin your application, see our guidelines
4
Discuss and share your project details (don't wait!)
6
See some examples of awesome proposals, add detail to yours :)
7
Submit your application!
*
Make a useful patch (be awesome)
(optional but recommended)

IF YOU GET SELECTED, BEFORE CODING BEGINS
Agree to the acceptance requirements
(you must do this in writing)
Read our participation expectations
(read it ALL, we will quiz you later)
Set up an interaction schedule with your mentors
(at least weekly)
Fill out your profile
(one sentence summary, your name, link to proposal, dev log, and melange page)
Get familiarized with web resources
BRL-CAD OpenSCAD LibreCAD STEPcode
Web
Wiki Docs
SF Project Site
Dev Rules
Patches
Web Web Web
Post your proposal online
(on our wiki is fine)
  • Describe your project plan
  • Document a list of 3 to 10 milestones
Announce your plan via Chat and/or E-mail
(discuss and make adjustments)
Download the source code, get set up
(compile, install, run)
BRL-CAD OpenSCAD LibreCAD STEPcode
Sources
Web Sources
Compiling
Sources
Compiling
Sources
Compiling
Sources
Compiling
Submit patches to get familiarized with code
(find small tasks like these)
A few more things...
BRL-CAD OpenSCAD LibreCAD STEPcode
Create a Sourceforge and brlcad.org wiki account.
Make perfect patches to obtain commit access.

ONCE CODING BEGINS
Write maintainable, portable, complete code
Keep a daily log of your activities online somewhere (wiki user page is great for this)
Provide a midterm report on your project progress to the mailing list
Stay motivated, engage other devs, allocate time for discussions
Provide a final report on your project progress to the mailing list
Keep working on BRL-CAD, OpenSCAD, LibreCAD, or STEPcode  :-)