Difference between revisions of "Summer of Code/Checklist"

From BRL-CAD
(fix numbering)
Line 50: Line 50:
 
|colspan=4|Discuss and share your project details (don't wait!)<br>
 
|colspan=4|Discuss and share your project details (don't wait!)<br>
 
|-
 
|-
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px; height:25px; border:1px solid #333;">6</div>
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px; height:25px; border:1px solid #333;">5</div>
 
|colspan=4|See [[Google_Summer_of_Code/2013|some examples]] of awesome proposals, add detail to yours ''':)'''
 
|colspan=4|See [[Google_Summer_of_Code/2013|some examples]] of awesome proposals, add detail to yours ''':)'''
 
|-
 
|-
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px; height:25px; border:1px solid #333;">7</div>
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px; height:25px; border:1px solid #333;">6</div>
 
|colspan=4|'''[http://www.google-melange.com/ 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;">8</div>
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px; height:25px; border:1px solid #333;">7</div>
 
|colspan=4|Make a useful patch  ''(be awesome)''<br><div style="font-size:50%">(optional but recommended)</div>
 
|colspan=4|Make a useful patch  ''(be awesome)''<br><div style="font-size:50%">(optional but recommended)</div>
 
|-
 
|-
Line 63: Line 63:
 
!colspan=5|<u>IF YOU GET SELECTED, BEFORE CODING BEGINS</u>
 
!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;">9</div>
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">8</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>
 
|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;">10</div>
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">9</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>
 
|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;">11</div>
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">10</div>
 
|colspan=4|Set up an interaction schedule with your mentors<br><div style="font-size:50%">(at least weekly)</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;">12</div>
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">11</div>
 
|colspan=4|Fill out [http://brlcad.org/wiki/Google_Summer_of_Code/2019 your profile]<div style="font-size:50%">(one sentence summary, your name, link to abstract, project plan, dev log, and final report)</div>
 
|colspan=4|Fill out [http://brlcad.org/wiki/Google_Summer_of_Code/2019 your profile]<div style="font-size:50%">(one sentence summary, your name, link to abstract, project plan, dev log, and final report)</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;">12</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%"
Line 93: Line 93:
 
|}
 
|}
 
|-
 
|-
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">14</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|Post your proposal online<br><div style="font-size:50%">(on our wiki is fine)</div>
 
|colspan=4|Post your proposal online<br><div style="font-size:50%">(on our wiki is fine)</div>
 
* Describe your project plan
 
* Describe your project plan
 
* Document a list of 3 to 10 milestones
 
* 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;">15</div>
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">14</div>
 
|colspan=4|Announce your plan via Chat and/or E-mail<br><div style="font-size:50%">(discuss and make adjustments)</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;">16</div>
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">15</div>
 
|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%"
Line 119: Line 119:
 
|}
 
|}
 
|-
 
|-
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">17</div>
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">16</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>
 
|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>
 
<div style="font-size:50%">(go through the mged [http://brlcad.org/w/images/c/cf/Introduction_to_MGED.pdf tutorial](cheat sheet
 
<div style="font-size:50%">(go through the mged [http://brlcad.org/w/images/c/cf/Introduction_to_MGED.pdf tutorial](cheat sheet
 
[http://brlcad.org/MGED_Quick_Reference_Card.pdf here])</div>  
 
[http://brlcad.org/MGED_Quick_Reference_Card.pdf here])</div>  
 
|-
 
|-
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">18</div>
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">17</div>
 
|colspan=4|A few more things...
 
|colspan=4|A few more things...
 
{|width=100% style="font-size:75%"
 
{|width=100% style="font-size:75%"
Line 146: Line 146:
 
!colspan=5|<u>ONCE CODING BEGINS</u>
 
!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;">19</div>
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">18</div>
 
|colspan=4|Write maintainable, portable, complete code
 
|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;">20</div>
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">19</div>
 
|colspan=4|Keep a '''daily''' log of your activities online somewhere (a blog or your 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;">20</div>
 
|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.
 
|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;">21</div>
 
|colspan=4|Stay motivated, engage other devs, allocate time for discussions
 
|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;">23</div>
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">22</div>
 
|colspan=4|Provide a final report on your project progress to the mailing list
 
|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;">24</div>
+
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">23</div>
 
|colspan=4|'''Keep working on BRL-CAD, OpenSCAD, LibreCAD, FreeCAD, Slic3r, or STEPcode  :-)'''
 
|colspan=4|'''Keep working on BRL-CAD, OpenSCAD, LibreCAD, FreeCAD, Slic3r, or STEPcode  :-)'''
 
|}
 
|}

Revision as of 13:36, 31 March 2020

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
Zulip: chat Chat: #openscad Chat: #librecad Chat: #freecad Chat: #stepcode Chat: #slic3r
IRC: #brlcad

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!)
5
See some examples of awesome proposals, add detail to yours :)
6
Submit your application!
7
Make a useful patch (be awesome)
(optional but recommended)

IF YOU GET SELECTED, BEFORE CODING BEGINS
8
Agree to the acceptance requirements
(you must do this in writing)
9
Read our participation expectations
(read it ALL, we will quiz you later)
10
Set up an interaction schedule with your mentors
(at least weekly)
11
Fill out your profile
(one sentence summary, your name, link to abstract, project plan, dev log, and final report)
12
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
13
Post your proposal online
(on our wiki is fine)
  • Describe your project plan
  • Document a list of 3 to 10 milestones
14
Announce your plan via Chat and/or E-mail
(discuss and make adjustments)
15
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
16
Submit patches to get familiarized with code
(find small tasks like these)
(go through the mged tutorial(cheat sheet here)
17
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
18
Write maintainable, portable, complete code
19
Keep a daily log of your activities online somewhere (a blog or your wiki user page is great for this)
20
Provide a midterm report on your project progress to the mailing list as well as posting it to your blog or wiki log.
21
Stay motivated, engage other devs, allocate time for discussions
22
Provide a final report on your project progress to the mailing list
23
Keep working on BRL-CAD, OpenSCAD, LibreCAD, FreeCAD, Slic3r, or STEPcode :-)