GSoC Checklist

From FreeCAD Documentation
Revision as of 20:23, 6 February 2023 by Kkremitzki (talk | contribs) (Create page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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.
FreeCAD
Forum: Developer/User Forum
Chat: #freecad

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
FreeCAD
Web
Wiki
Forum
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)
FreeCAD
Sources
Compiling
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...
FreeCAD
Everything happens on the forum. It is the one and only place where all ideas are discussed.

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 FreeCAD  :-)