GSoC Checklist: Difference between revisions
Kkremitzki (talk | contribs) (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. |
||
=== Applying === |
|||
# Check out our [[ |
# 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 [ |
# 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 |
# 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 |
# 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 |
# Announce your plan on the forum |
||
# Download the source code, |
# 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 |
# Keep a '''daily''' log of your activities on your forum thread |
||
# Provide a midterm report on your project progress |
# 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]] |
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
- Check out our Project Ideas
- 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.
- 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 on the forum (don't wait, the sooner the better your proposal can be!)
- Submit your application
- Wait for the results
When you get selected
- 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.
- Set up an interaction schedule with your mentors
- Get familiarized with web resources: Homepage, Wiki, Forum
- Post your proposal online. Create a thread for your project under the GSoC forum.
- Describe your project plan
- Document a list of 3 to 10 milestones
- Announce your plan on the forum
- Download or clone the source code, and make sure you are able to compile FreeCAD successfully (compile, install, run) Source & Compiling
Once coding begins
- Write maintainable, portable, complete code
- Keep a daily log of your activities on your forum thread
- Provide a midterm report on your project progress to your forum thread
- Stay motivated, engage other devs, allocate time for discussions
- Provide a final report on your project progress to the mailing list
- Keep working on FreeCAD :-)
- Submit patches to get familiarized with code; find small tasks like these