Summer of Code/Checklist

From BRL-CAD
Revision as of 11:28, 3 May 2016 by Yorikvanhavre (talk | contribs) (Added FreeCAD info to "18 - a few more things" section)

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 FreeCAD STEPcode LinuxCNC
E-Mail: brlcad-devel E-Mail: openscad E-Mail: LibreCAD-dev Forum: Developer/User Forum E-Mail: scl-dev E-Mail: emc-developers
Chat: #brlcad Chat: #openscad Chat: #librecad Chat: #freecad Chat: #stepcode Chat: #linuxcnc-devel

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!
8
Make a useful patch (be awesome)
(optional but recommended)

IF YOU GET SELECTED, BEFORE CODING BEGINS
9
Agree to the acceptance requirements
(you must do this in writing)
10
Read our participation expectations
(read it ALL, we will quiz you later)
11
Set up an interaction schedule with your mentors
(at least weekly)
12
Fill out your profile
(one sentence summary, your name, link to proposal, dev log, and melange page)
13
Get familiarized with web resources
BRL-CAD OpenSCAD LibreCAD FreeCAD STEPcode LinuxCNC
Web
Wiki Docs
SF Project Site
Dev Rules
Patches
Web
User Manual
Dev-Wiki
Web
Get Involved
Web
Wiki
Forum
Web Web
Forum
Wiki
How to contribute
14
Post your proposal online
(on our wiki is fine)
  • Describe your project plan
  • Document a list of 3 to 10 milestones
15
Announce your plan via Chat and/or E-mail
(discuss and make adjustments)
16
Download the source code, get set up
(compile, install, run)
BRL-CAD OpenSCAD LibreCAD FreeCAD STEPcode LinuxCNC
Sources
Web Sources
Compiling
Sources
Compiling
Sources
Compiling
Sources
Compiling
Sources
Compiling
main git repo
github mirror
17
Submit patches to get familiarized with code
(find small tasks like these)
(go through the mged tutorial(cheat sheet here)
18
A few more things...
BRL-CAD OpenSCAD LibreCAD FreeCAD STEPcode LinuxCNC
Create a Sourceforge and brlcad.org wiki account.
Make perfect patches to obtain commit access.
Everything happens on the forum. It is the one and only place where all ideas are discussed. Come talk to us on IRC! Several core developers idle in #linuxcnc-devel constantly.

ONCE CODING BEGINS
19
Write maintainable, portable, complete code
20
Keep a daily log of your activities online somewhere (a blog or your wiki user page is great for this)
21
Provide a midterm report on your project progress to the mailing list as well as posting it to your blog or wiki log.
22
Stay motivated, engage other devs, allocate time for discussions
23
Provide a final report on your project progress to the mailing list
24
Keep working on BRL-CAD, OpenSCAD, LibreCAD, FreeCAD, LinuxCNC, or STEPcode :-)