Difference between revisions of "Summer of Code/Checklist"

From BRL-CAD
(completely redo and revamp the checklist this year, more generalized, distinctly call out our collaborator resources where needed)
(Add OpenSCAD user manual and dev-wiki links)
Line 71: Line 71:
 
|-
 
|-
 
|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://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://www.openscad.org/ Web]<br>[https://en.wikibooks.org/wiki/OpenSCAD_User_Manual User Manual]<br>[https://github.com/openscad/openscad/wiki Dev-Wiki]
 
|style="text-align:left; vertical-align:top;"|[http://librecad.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:left; vertical-align:top;"|[http://stepcode.org/ Web]

Revision as of 15:21, 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
User Manual
Dev-Wiki
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 :-)