GSoC Checklist: Difference between revisions

From FreeCAD Documentation
(Condense into simpler lists)
No edit summary
 
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.
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''' =====
=== Applying ===


# Check out our [[Google_Summer_of_Code_2023#Implementation_Ideas|Project Ideas]]
# Check out our [[Google_Summer_of_Code_2024#Implementation_Ideas|Project Ideas]]
# Introduce yourself! Don't be shy. The main place where the FreeCAD community meets is the [https://forum.freecad.org FreeCAD forum]. Create yourself an account, introduce yourself, and tell a bit about what you would like to do with FreeCAD or ask for ideas. You can post for example under the [https://forum.freecad.org/viewforum.php?f=8 Open discussion] section or the [https://forum.freecad.org/viewforum.php?f=46 GSoC] section.
# Introduce yourself! Don't be shy. Forum: [http://forum.freecad.org Developer/User Forum] Chat: [irc://irc.libera.chat/#freecad #freecad] See [https://brlcad.org/wiki/IRC IRC] if you've never used it before. Ask specific questions and wait! [http://web.libera.chat/#freecad Web interface here].
# Begin your application, see [https://brlcad.org/wiki/Summer_of_Code/Application_Guidelines guidelines]
# Begin your application, see [[GSoC Application Guidelines]]
# See proposal ideas on the [[Google Summer of Code 2024]] page, or make up your own idea!
# Discuss and share your project details (don't wait!)
# Discuss and share your project details on the forum (don't wait, the sooner the better your proposal can be!)
# See [https://brlcad.org/wiki/Google_Summer_of_Code/2013 some examples] of awesome proposals, add detail to yours :)
# [https://summerofcode.withgoogle.com/ Submit your application!]
# [https://summerofcode.withgoogle.com/ Submit your application]
# Wait for the results
# Make a useful patch (be awesome)


=== When you get selected ===
===== '''IF YOU GET SELECTED, BEFORE CODING BEGINS''' =====

# Agree to the [https://brlcad.org/wiki/Summer_of_Code/Acceptance requirements] (you must do this in writing)
# Read our [https://brlcad.org/wiki/Summer_of_Code/Expectations expectations] (read it ALL, we will quiz you later)
# Read the BRL-CAD [https://brlcad.org/wiki/Summer_of_Code/Acceptance requirements]and [https://brlcad.org/wiki/Summer_of_Code/Expectations expectations]. FreeCAD is not applying under the BRL-CAD umbrella anymore, but we still follow the same guidelines and ways of doing. We will request that you commit to your work, and communicate often.
# Set up an interaction schedule with your mentors
# Set up an interaction schedule with your mentors
# Fill out your profile (one sentence summary, your name, link to abstract, project plan, dev log, and final report)
# Get familiarized with web resources: [https://freecad.org Homepage], [https://wiki.freecad.org Wiki], [https://forum.freecad.org Forum]
# Get familiarized with web resources: [https://freecad.org Homepage], [https://wiki.freecad.org Wiki], [https://forum.freecad.org Forum]
# Post your proposal online (on our wiki is fine)
# Post your proposal online. Create a thread for your project under the [https://forum.freecad.org/viewforum.php?f=46 GSoC forum].
# Describe your project plan
# Describe your project plan
# Document a list of 3 to 10 milestones
# Document a list of 3 to 10 milestones
# Announce your plan via Chat and/or E-mail (discuss and make adjustments)
# Announce your plan on the forum
# Download the source code, get set up (compile, install, run) [https://github.com/FreeCAD/FreeCAD Source] & [[Compiling]]
# Download or clone the source code, and make sure you are able to compile FreeCAD successfully (compile, install, run) [https://github.com/FreeCAD/FreeCAD Source] & [[Compiling]]

=== Once coding begins ===


===== '''ONCE CODING BEGINS''' =====
# Write maintainable, portable, complete code
# Write maintainable, portable, complete code
# Keep a '''daily''' log of your activities online somewhere (a blog or your wiki user page is great for this)
# Keep a '''daily''' log of your activities on your forum thread
# Provide a midterm report on your project progress to the mailing list as well as posting it to your blog or wiki log.
# Provide a midterm report on your project progress to your forum thread
# Stay motivated, engage other devs, allocate time for discussions
# Stay motivated, engage other devs, allocate time for discussions
# Provide a final report on your project progress to the mailing list
# Provide a final report on your project progress to the mailing list
Line 32: Line 32:
# Submit patches to get familiarized with code; find small tasks [https://github.com/FreeCAD/FreeCAD/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22 like these]
# Submit patches to get familiarized with code; find small tasks [https://github.com/FreeCAD/FreeCAD/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22 like these]


[[category:Google Summer of Code]]
[[Category:Google Summer of Code]]

Latest revision as of 12:17, 1 February 2024

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.

Applying

  1. Check out our Project Ideas
  2. Introduce yourself! Don't be shy. The main place where the FreeCAD community meets is the FreeCAD forum. Create yourself an account, introduce yourself, and tell a bit about what you would like to do with FreeCAD or ask for ideas. You can post for example under the Open discussion section or the GSoC section.
  3. Begin your application, see GSoC Application Guidelines
  4. See proposal ideas on the Google Summer of Code 2024 page, or make up your own idea!
  5. Discuss and share your project details on the forum (don't wait, the sooner the better your proposal can be!)
  6. Submit your application
  7. Wait for the results

When you get selected

  1. Read the BRL-CAD requirementsand expectations. FreeCAD is not applying under the BRL-CAD umbrella anymore, but we still follow the same guidelines and ways of doing. We will request that you commit to your work, and communicate often.
  2. Set up an interaction schedule with your mentors
  3. Get familiarized with web resources: Homepage, Wiki, Forum
  4. Post your proposal online. Create a thread for your project under the GSoC forum.
  5. Describe your project plan
  6. Document a list of 3 to 10 milestones
  7. Announce your plan on the forum
  8. Download or clone the source code, and make sure you are able to compile FreeCAD successfully (compile, install, run) Source & Compiling

Once coding begins

  1. Write maintainable, portable, complete code
  2. Keep a daily log of your activities on your forum thread
  3. Provide a midterm report on your project progress to your forum thread
  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