Editing Summer of Code/Checklist

From BRL-CAD

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
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.
+
= GSoC Checklist =
  
{| class="wikitable" style="width: 800px; padding: 8px; border: 1px solid #fff; text-align: left; background-color:#f7f7f7;"
+
Before the summer coding begins, there are several things that students should do to become familiarized with BRL-CAD development. Below is a checklist of things each student should complete before the official GSoC coding start date. Some items on the checklist should occur during the application submission process while others need to occur before it's time to start coding.   
!colspan=5|<u>IN ORDER TO APPLY</u>
 
|-
 
| style="width: 3%; text-align:center; vertical-align:top;"|
 
| colspan=4|
 
|-
 
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333; margin-right:4px;">1</div>
 
|colspan=4|Check out our [[Google_Summer_of_Code/Project_Ideas|Project Ideas]]
 
|-
 
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px;height:25px;border:1px solid #333;">2</div>
 
|colspan=4|Introduce yourself!  Don't be shy.<br>
 
{|width=100% style="font-size:75%"
 
| style="width: 16%; background-color: #eee; text-align:center;"| BRL-CAD
 
| style="width: 17%; background-color: #eee; text-align:center;"| OpenSCAD
 
| style="width: 16%; background-color: #eee; text-align:center;"| LibreCAD
 
| 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: [http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org openscad]
 
|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: [mailto:alessandro@pintle.it alessandro@pintle.it]
 
|-
 
|style="text-align:left;"|Zulip: [https://brlcad.zulipchat.com/ chat]
 
|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/#freecad #freecad]
 
|style="text-align:left;"|Chat: [irc://irc.freenode.net/#stepcode #stepcode]
 
|style="text-align:left;"|Chat: [irc://irc.freenode.net/#slic3r #slic3r]
 
|-
 
|style="text-align:left;"|IRC: [irc://irc.freenode.net/#brlcad #brlcad]
 
|style="text-align:left;"|
 
|style="text-align:left;"|
 
|style="text-align:left;"|
 
|style="text-align:left;"|
 
|style="text-align:left;"|
 
|}
 
See [[IRC]] if you've never used it beforeAsk specific questions and wait!  [http://webchat.freenode.net/ Web interface here].
 
  
|-
+
== IN ORDER TO APPLY ==
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px; height:25px; border:1px solid #333;">3</div>
 
|colspan=4|Begin your application, see [[Summer_of_Code/Application_Guidelines|our guidelines]]
 
|-
 
| style="text-align:center; vertical-align:top;"|<div style="background-color:#fff; width:25px; height:25px; border:1px solid #333;">4</div>
 
|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;">5</div>
 
|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;">6</div>
 
|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;">7</div>
 
|colspan=4|Make a useful patch  ''(be awesome)''<br><div style="font-size:50%">(optional but recommended)</div>
 
|-
 
|colspan=5|<br>
 
|-
 
!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;">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>
 
|-
 
| 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>
 
|-
 
| 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>
 
|-
 
| 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/2020 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;">12</div>
 
|colspan=4|Get familiarized with web resources
 
{|width=100% style="font-size:75%"
 
| style="width: 16%; background-color: #eee; text-align:center;"| BRL-CAD
 
| style="width: 17%; background-color: #eee; text-align:center;"| OpenSCAD
 
| style="width: 16%; background-color: #eee; text-align:center;"| LibreCAD
 
| 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://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]<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://slic3r.org/ Web]<br>[https://github.com/alexrj/Slic3r GitHub repository]
 
|}
 
|-
 
| 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>
 
* Describe your project plan
 
* 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;">14</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;">15</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%"
 
| style="width: 16%; background-color: #eee; text-align:center;"| BRL-CAD
 
| style="width: 17%; background-color: #eee; text-align:center;"| OpenSCAD
 
| style="width: 16%; background-color: #eee; text-align:center;"| LibreCAD
 
| 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;"|[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/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/alexrj/Slic3r git repo]
 
|}
 
|-
 
| 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>
 
<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>
 
|-
 
| 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...
 
{|width=100% style="font-size:75%"
 
| style="width: 16%; background-color: #eee; text-align:center;"| BRL-CAD
 
| style="width: 17%; background-color: #eee; text-align:center;"| OpenSCAD
 
| style="width: 16%; background-color: #eee; text-align:center;"| LibreCAD
 
| 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;"|
 
|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;"|Everything happens in the GitHub issue tracker. Also find us in #slic3r!
 
|}
 
|-
 
|colspan=5|<br>
 
|-
 
!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;">18</div>
 
|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;">19</div>
 
|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;">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.
 
|-
 
| 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
 
|-
 
| 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
 
|-
 
| 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  :-)'''
 
|}
 
  
 +
# Review our [[Google_Summer_of_Code/Project_Ideas|Project Ideas]]
 +
# Follow the [[Google_Summer_of_Code/Application_Guidelines|Application Guidelines]]
 +
# Understand your [[Google Summer of Code/Acceptance|Acceptance Requirements]]
 +
# Join the [http://irc.brlcad.org #brlcad IRC channel] and introduce yourself
 +
# Join the [https://lists.sourceforge.net/lists/listinfo/brlcad-devel brlcad-devel mailing list] and introduce yourself
 +
# Discuss your application with the mentors
 +
# Prepare your application
 +
# Discuss your application with the mentors some more :)
 +
## ''(optional) Post your application to your wiki user page (/wiki/User:username)''
 +
## ''(optional) Share and discuss your application on the mailing list''
 +
# '''[http://sourceforge.net/tracker/?func=add&group_id=105292&atid=640804 Submit a patch] if you don't have commit access'''
 +
# [http://socghop.appspot.com/ Submit your application]
  
[[category:Summer of Code]]
+
== IF YOU ARE ACCEPTED ==
 +
 
 +
* Agree to the [[Google_Summer_of_Code/Acceptance|acceptance requirements]]
 +
* Read our [[Google_Summer_of_Code/Expectations|participation expectations]]
 +
* Read the [http://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk/HACKING development guidelines]
 +
* Familiarize yourself with Subversion
 +
* '''''Compile and run BRL-CAD from source'''''
 +
* Familiarize yourself with BRL-CAD's on-line resources
 +
** http://brlcad.org
 +
** http://brlcad.org/wiki
 +
** http://brlcad.org/gallery
 +
** http://brlcad.org/d/documentation
 +
** http://sf.net/projects/brlcad
 +
* Create a Sourceforge and brlcad.org wiki account
 +
* Publish a development plan to the wiki
 +
** Document a list of 3 to 10 development milestones
 +
** Document your plan on the Wiki as a design document
 +
* Discuss your plan via irc and/or on the mailing list
 +
* Set up an interaction schedule with your mentor
 +
* Become a productive developer
 +
** '''''[http://sourceforge.net/tracker/?group_id=105292&atid=640804 Post patches] until you get commit access'''''
 +
** Write maintainable, portable, complete code
 +
** Keep a '''daily''' log of your activities online somewhere (wiki user page is great for this)
 +
** Report your progress periodically to the mailing list
 +
* Provide a final report on your project progress to the mailing list
 +
* '''Continue working on BRL-CAD  :-)'''
 +
 
 +
[[category:Google Summer of Code]]

Please note that all contributions to BRL-CAD may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see BRL-CAD:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)