Difference between revisions of "Summer of Code/Checklist"

m (added refference to mged tutorial and cheat sheet)
 
(16 intermediate revisions by 11 users not shown)
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: 16%; background-color: #eee; text-align:center;"| BRL-CAD
| style="width: 25%; background-color: #eee; text-align:center;"| OpenSCAD
+
| style="width: 17%; background-color: #eee; text-align:center;"| OpenSCAD
| style="width: 25%; background-color: #eee; text-align:center;"| LibreCAD
+
| style="width: 16%; background-color: #eee; text-align:center;"| LibreCAD
| style="width: 25%; background-color: #eee; text-align:center;"| STEPcode
+
| style="width: 17%; background-color: #eee; text-align:center;"| FreeCAD
 +
| style="width: 17%; background-color: #eee; text-align:center;"| STEPcode
 +
| style="width: 16%; background-color: #eee; text-align:center;"| Slic3r
 
|-
 
|-
 
|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]
 
|style="text-align:left;"|E-Mail: [http://rocklinux.net/mailman/listinfo/openscad openscad]
 
|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: [http://forum.librecad.org/LibreCAD-dev-f4361976.html LibreCAD-dev]
 +
|style="text-align:left;"|Forum: [http://forum.freecadweb.org Developer/User Forum]
 
|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: [mailto:alessandro@pintle.it alessandro@pintle.it]
 
|-
 
|-
 
|style="text-align:left;"|Chat: [irc://irc.freenode.net/#brlcad #brlcad]
 
|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/#openscad #openscad]
 
|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/#freecad #freecad]
 
|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/#slic3r #slic3r]
 
|}
 
|}
 
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 60: Line 66:
 
|-
 
|-
 
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">12</div>
 
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">12</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>
+
|colspan=4|Fill out [http://brlcad.org/wiki/Google_Summer_of_Code/2017 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;">13</div>
 
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">13</div>
 
|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: 16%; background-color: #eee; text-align:center;"| BRL-CAD
| style="width: 25%; background-color: #eee; text-align:center;"| OpenSCAD
+
| style="width: 17%; background-color: #eee; text-align:center;"| OpenSCAD
| style="width: 25%; background-color: #eee; text-align:center;"| LibreCAD
+
| style="width: 16%; background-color: #eee; text-align:center;"| LibreCAD
| style="width: 25%; background-color: #eee; text-align:center;"| STEPcode
+
| style="width: 17%; background-color: #eee; text-align:center;"| FreeCAD
 +
| style="width: 17%; background-color: #eee; text-align:center;"| STEPcode
 +
| style="width: 16%; background-color: #eee; text-align:center;"| Slic3r
 
|-
 
|-
 
|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]<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://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]<br>[https://docs.google.com/document/d/16tFdu91lIVjWWz4Kjl7dF8HkRHGzgCKYciM9iZKVXK8/edit Get Involved]
 +
|style="text-align:left; vertical-align:top;"|[http://freecadweb.org Web]<br>[http://www.freecadweb.org/wiki/ Wiki]<br>[http://www.forum.freecadweb.org Forum]
 
|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://slic3r.org/ Web]<br>[https://github.com/alexrj/Slic3r GitHub repository]
 
|}
 
|}
 
|-
 
|-
Line 87: Line 97:
 
|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: 16%; background-color: #eee; text-align:center;"| BRL-CAD
| style="width: 25%; background-color: #eee; text-align:center;"| OpenSCAD
+
| style="width: 17%; background-color: #eee; text-align:center;"| OpenSCAD
| style="width: 25%; background-color: #eee; text-align:center;"| LibreCAD
+
| style="width: 16%; background-color: #eee; text-align:center;"| LibreCAD
| style="width: 25%; background-color: #eee; text-align:center;"| STEPcode
+
| style="width: 17%; background-color: #eee; text-align:center;"| FreeCAD
 +
| style="width: 17%; background-color: #eee; text-align:center;"| STEPcode
 +
| style="width: 16%; background-color: #eee; text-align:center;"| Slic3r
 
|-
 
|-
 
|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]]
|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/openscad/openscad Sources]<br>[https://github.com/openscad/openscad/blob/master/README.md 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/LibreCAD/LibreCAD Sources]<br>[http://librecad.org/cms/home/from-source/linux.html Compiling]
 +
|style="text-align:left; vertical-align:top;"|[https://github.com/FreeCAD Sources]<br>[http://www.freecadweb.org/wiki/index.php?title=Compiling 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;"|[https://github.com/alexrj/Slic3r git repo]
 
|}
 
|}
 
|-
 
|-
Line 106: Line 120:
 
|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: 16%; background-color: #eee; text-align:center;"| BRL-CAD
| style="width: 25%; background-color: #eee; text-align:center;"| OpenSCAD
+
| style="width: 17%; background-color: #eee; text-align:center;"| OpenSCAD
| style="width: 25%; background-color: #eee; text-align:center;"| LibreCAD
+
| style="width: 16%; background-color: #eee; text-align:center;"| LibreCAD
| style="width: 25%; background-color: #eee; text-align:center;"| STEPcode
+
| style="width: 17%; background-color: #eee; text-align:center;"| FreeCAD
 +
| style="width: 17%; background-color: #eee; text-align:center;"| STEPcode
 +
| style="width: 16%; background-color: #eee; text-align:center;"| Slic3r
 
|-
 
|-
 
|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.
 
|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;"|Everything happens on the forum. It is the one and only place where all ideas are discussed.
 
|style="text-align:left; vertical-align:top;"|
 
|style="text-align:left; vertical-align:top;"|
 +
|style="text-align:left; vertical-align:top;"|Everything happens in the GitHub issue tracker. Also find us in #slic3r!
 
|}
 
|}
 
|-
 
|-
Line 125: Line 143:
 
|-
 
|-
 
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">20</div>
 
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">20</div>
|colspan=4|Keep a '''daily''' log of your activities online somewhere (wiki user page is great for this)
+
|colspan=4|Keep a '''daily''' log of your activities online somewhere (a blog or your 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;">21</div>
 
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">21</div>
|colspan=4|Provide a midterm report on your project progress to the mailing list
+
|colspan=4|Provide a midterm report on your project progress to the mailing list as well as posting it to your blog or wiki log.
 
|-
 
|-
 
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">22</div>
 
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">22</div>
Line 137: Line 155:
 
|-
 
|-
 
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">24</div>
 
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">24</div>
|colspan=4|'''Keep working on BRL-CAD, OpenSCAD, LibreCAD, or STEPcode  :-)'''
+
|colspan=4|'''Keep working on BRL-CAD, OpenSCAD, LibreCAD, FreeCAD, Slic3r, or STEPcode  :-)'''
 
|}
 
|}
  
  
 
[[category:Summer of Code]]
 
[[category:Summer of Code]]

Latest revision as of 00:05, 5 May 2017

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 Slic3r
E-Mail: brlcad-devel E-Mail: openscad E-Mail: LibreCAD-dev Forum: Developer/User Forum E-Mail: scl-dev E-Mail: alessandro@pintle.it
Chat: #brlcad Chat: #openscad Chat: #librecad Chat: #freecad Chat: #stepcode Chat: #slic3r

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 Slic3r
Web
Wiki Docs
SF Project Site
Dev Rules
Patches
Web
User Manual
Dev-Wiki
Web
Get Involved
Web
Wiki
Forum
Web Web
GitHub repository
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 Slic3r
Sources
Web Sources
Compiling
Sources
Compiling
Sources
Compiling
Sources
Compiling
Sources
Compiling
git repo
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 Slic3r
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. Everything happens in the GitHub issue tracker. Also find us in #slic3r!

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, Slic3r, or STEPcode  :-)