GSoC Checklist

From FreeCAD Documentation
Revision as of 23:02, 8 February 2023 by Kkremitzki (talk | contribs) (Condense into simpler lists)

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. 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 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)
IF YOU GET SELECTED, BEFORE CODING BEGINS
  1. Agree to the requirements (you must do this in writing)
  2. Read our expectations (read it ALL, we will quiz you later)
  3. Set up an interaction schedule with your mentors
  4. Fill out your profile (one sentence summary, your name, link to abstract, project plan, dev log, and final report)
  5. Get familiarized with web resources: Homepage, Wiki, Forum
  6. Post your proposal online (on our wiki is fine)
  7. Describe your project plan
  8. Document a list of 3 to 10 milestones
  9. Announce your plan via Chat and/or E-mail (discuss and make adjustments)
  10. Download the source code, get set up (compile, install, run) Source & Compiling
ONCE CODING BEGINS
  1. Write maintainable, portable, complete code
  2. Keep a daily log of your activities online somewhere (a blog or your wiki user page is great for this)
  3. Provide a midterm report on your project progress to the mailing list as well as posting it to your blog or wiki log.
  4. Stay motivated, engage other devs, allocate time for discussions
  5. Provide a final report on your project progress to the mailing list
  6. Keep working on FreeCAD :-)
  7. Submit patches to get familiarized with code; find small tasks like these