Difference between revisions of "Summer of Code/Checklist"

(mention posting midterm report to blog or wiki page)
(add linuxcnc notes & links)
Line 13: Line 13:
 
|colspan=4|Introduce yourself!  Don't be shy.<br>
 
|colspan=4|Introduce yourself!  Don't be shy.<br>
 
{|width=100% style="font-size:75%"
 
{|width=100% style="font-size:75%"
| style="width: 25%; background-color: #eee; text-align:center;"| BRL-CAD
+
| style="width: 20%; background-color: #eee; text-align:center;"| BRL-CAD
| style="width: 25%; background-color: #eee; text-align:center;"| OpenSCAD
+
| style="width: 20%; background-color: #eee; text-align:center;"| OpenSCAD
| style="width: 25%; background-color: #eee; text-align:center;"| LibreCAD
+
| style="width: 20%; background-color: #eee; text-align:center;"| LibreCAD
| style="width: 25%; background-color: #eee; text-align:center;"| STEPcode
+
| style="width: 20%; background-color: #eee; text-align:center;"| STEPcode
 +
| style="width: 20%; background-color: #eee; text-align:center;"| LinuxCNC
 
|-
 
|-
 
|style="text-align:left;"|E-Mail: [https://lists.sourceforge.net/lists/listinfo/brlcad-devel brlcad-devel]
 
|style="text-align:left;"|E-Mail: [https://lists.sourceforge.net/lists/listinfo/brlcad-devel brlcad-devel]
Line 22: Line 23:
 
|style="text-align:left;"|E-Mail: [http://forum.librecad.org/LibreCAD-dev-f4361976.html LibreCAD-dev]
 
|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;"|E-Mail: [https://groups.google.com/forum/?fromgroups#!forum/scl-dev scl-dev]
 +
|style="text-align:left;"|E-Mail: [https://lists.sourceforge.net/lists/listinfo/emc-developers emc-developers]
 
|-
 
|-
 
|style="text-align:left;"|Chat: [irc://irc.freenode.net/#brlcad #brlcad]
 
|style="text-align:left;"|Chat: [irc://irc.freenode.net/#brlcad #brlcad]
Line 27: Line 29:
 
|style="text-align:left;"|Chat: [irc://irc.freenode.net/#librecad #librecad]
 
|style="text-align:left;"|Chat: [irc://irc.freenode.net/#librecad #librecad]
 
|style="text-align:left;"|Chat: [irc://irc.freenode.net/#stepcode #stepcode]
 
|style="text-align:left;"|Chat: [irc://irc.freenode.net/#stepcode #stepcode]
 +
|style="text-align:left;"|Chat: [irc://irc.freenode.net/#linuxcnc-devel #linuxcnc-devel]
 
|}
 
|}
 
See [[IRC]] if you've never used it before.  Ask specific questions and wait!  [http://webchat.freenode.net/ Web interface here].
 
See [[IRC]] if you've never used it before.  Ask specific questions and wait!  [http://webchat.freenode.net/ Web interface here].
Line 65: Line 68:
 
|colspan=4|Get familiarized with web resources
 
|colspan=4|Get familiarized with web resources
 
{|width=100% style="font-size:75%"
 
{|width=100% style="font-size:75%"
| style="width: 25%; background-color: #eee; text-align:center;"| BRL-CAD
+
| style="width: 20%; background-color: #eee; text-align:center;"| BRL-CAD
| style="width: 25%; background-color: #eee; text-align:center;"| OpenSCAD
+
| style="width: 20%; background-color: #eee; text-align:center;"| OpenSCAD
| style="width: 25%; background-color: #eee; text-align:center;"| LibreCAD
+
| style="width: 20%; background-color: #eee; text-align:center;"| LibreCAD
| style="width: 25%; background-color: #eee; text-align:center;"| STEPcode
+
| style="width: 20%; background-color: #eee; text-align:center;"| STEPcode
 +
| style="width: 20%; background-color: #eee; text-align:center;"| LinuxCNC
 
|-
 
|-
 
|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]]
Line 74: Line 78:
 
|style="text-align:left; vertical-align:top;"|[http://librecad.org/ Web]<br>[https://docs.google.com/document/d/16tFdu91lIVjWWz4Kjl7dF8HkRHGzgCKYciM9iZKVXK8/edit Get Involved]
 
|style="text-align:left; vertical-align:top;"|[http://librecad.org/ Web]<br>[https://docs.google.com/document/d/16tFdu91lIVjWWz4Kjl7dF8HkRHGzgCKYciM9iZKVXK8/edit Get Involved]
 
|style="text-align:left; vertical-align:top;"|[http://stepcode.org/ Web]
 
|style="text-align:left; vertical-align:top;"|[http://stepcode.org/ Web]
 +
|style="text-align:left; vertical-align:top;"|[http://linuxcnc.org/ Web]<br>[http://linuxcnc.org/index.php/forum/index Forum]<br>[http://wiki.linuxcnc.org/ Wiki]<br>[http://linuxcnc.org/docs/devel/html/code/Contributing-to-LinuxCNC.html How to contribute]
 
|}
 
|}
 
|-
 
|-
Line 87: Line 92:
 
|colspan=4|Download the source code, get set up<br><div style="font-size:50%">(compile, install, run)</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%"
 
{|width=100% style="font-size:75%"
| style="width: 25%; background-color: #eee; text-align:center;"| BRL-CAD
+
| style="width: 20%; background-color: #eee; text-align:center;"| BRL-CAD
| style="width: 25%; background-color: #eee; text-align:center;"| OpenSCAD
+
| style="width: 20%; background-color: #eee; text-align:center;"| OpenSCAD
| style="width: 25%; background-color: #eee; text-align:center;"| LibreCAD
+
| style="width: 20%; background-color: #eee; text-align:center;"| LibreCAD
| style="width: 25%; background-color: #eee; text-align:center;"| STEPcode
+
| style="width: 20%; background-color: #eee; text-align:center;"| STEPcode
 +
| style="width: 20%; background-color: #eee; text-align:center;"| LinuxCNC
 
|-
 
|-
 
|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;"|[http://sourceforge.net/p/brlcad/code/HEAD/tree/ Sources]<br>[https://github.com/BRL-CAD/web Web Sources]<br>[[Compiling]]
Line 96: Line 102:
 
|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/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>[http://stepcode.org/mw/index.php?title=Building_STEPcode Compiling]
 
|style="text-align:left; vertical-align:top;"|[https://github.com/stepcode/stepcode Sources]<br>[http://stepcode.org/mw/index.php?title=Building_STEPcode Compiling]
 +
|style="text-align:left; vertical-align:top;"|[http://git.linuxcnc.org/gitweb?p=linuxcnc.git main git repo]<br>[https://github.com/jepler/linuxcnc-mirror github mirror]
 
|}
 
|}
 
|-
 
|-
Line 106: Line 113:
 
|colspan=4|A few more things...
 
|colspan=4|A few more things...
 
{|width=100% style="font-size:75%"
 
{|width=100% style="font-size:75%"
| style="width: 25%; background-color: #eee; text-align:center;"| BRL-CAD
+
| style="width: 20%; background-color: #eee; text-align:center;"| BRL-CAD
| style="width: 25%; background-color: #eee; text-align:center;"| OpenSCAD
+
| style="width: 20%; background-color: #eee; text-align:center;"| OpenSCAD
| style="width: 25%; background-color: #eee; text-align:center;"| LibreCAD
+
| style="width: 20%; background-color: #eee; text-align:center;"| LibreCAD
| style="width: 25%; background-color: #eee; text-align:center;"| STEPcode
+
| style="width: 20%; background-color: #eee; text-align:center;"| STEPcode
 +
| style="width: 20%; background-color: #eee; text-align:center;"| LinuxCNC
 
|-
 
|-
 
|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;"|Create a Sourceforge and brlcad.org wiki account.<br>Make ''perfect'' patches to obtain commit access.
Line 115: Line 123:
 
|style="text-align:left; vertical-align:top;"|
 
|style="text-align:left; vertical-align:top;"|
 
|style="text-align:left; vertical-align:top;"|
 
|style="text-align:left; vertical-align:top;"|
 +
|style="text-align:left; vertical-align:top;"|Come talk to us on IRC!  Several core developers idle in #linuxcnc-devel constantly.
 
|}
 
|}
 
|-
 
|-

Revision as of 00:15, 6 March 2015

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 LinuxCNC
E-Mail: brlcad-devel E-Mail: openscad E-Mail: LibreCAD-dev E-Mail: scl-dev E-Mail: emc-developers
Chat: #brlcad Chat: #openscad Chat: #librecad 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 STEPcode LinuxCNC
Web
Wiki Docs
SF Project Site
Dev Rules
Patches
Web
User Manual
Dev-Wiki
Web
Get Involved
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 STEPcode LinuxCNC
Sources
Web 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 STEPcode LinuxCNC
Create a Sourceforge and brlcad.org wiki account.
Make perfect patches to obtain commit access.
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, or STEPcode  :-)