Difference between revisions of "GSoC"

From coreboot
Jump to: navigation, search
(Important dates)
(Remove flashrom from the project list for 2017)
 
(42 intermediate revisions by 7 users not shown)
Line 1: Line 1:
Welcome to coreboot [http://www.google-melange.com/gsoc/homepage/google/gsoc2013 Google Summer of Code, 2013].  
+
coreboot is applying for [https://summerofcode.withgoogle.com/ Google Summer of Code 2017] as a mentoring organization.
 +
It is not assumed that we are accepted yet. We will announce this on the mailing list, chat.coreboot.org and update this page when we are informed on 27 February.
  
coreboot has many [[Project Ideas]] for various firmware ability levels. The coreboot project also hosts [http://flashrom.org/GSoC flashrom] and [http://serialice.com/GSoC SerialICE] projects.
+
coreboot has many [[Project Ideas]] for various ability levels. The coreboot project also acts as an umbrella organization for other open-source firmware related projects.
 +
 
 +
Official student application period in 2017 is from March 20 to April 3, with results announced on April 4.  For the complete timeline, please see the [https://summerofcode.withgoogle.com/how-it-works/#timeline GSoC 2017 timeline].
  
 
__FORCETOC__
 
__FORCETOC__
  
== coreboot contact ==
+
== coreboot contacts ==
  
If you are interested in becoming a GSoC student, please contact the coreboot [[Mailinglist|mailing list]] or visit our [[IRC]] channel <code>#coreboot</code> on [https://webchat.freenode.net irc.freenode.net].
+
If you are interested in participating in GSoC as a student student, please visit [https://chat.coreboot.org/ chat.coreboot.org]. Working closely with the community is highly encouraged, as we've seen that our most successful students are generally very involved.
  
If you need to contact someone directly, [mailto:marcj303@gmail.com Marc Jones] is the GSoC admin for coreboot.
+
[[User:PatrickGeorgi|Patrick Georgi]] and [[User:MartinRoth|Martin Roth]] are the coreboot GSoC admins for 2017.  Please feel free to reach out to them directly if you have any questions.
<br/><br/>
 
  
= Why work on coreboot for GSoC 2013? =
+
= Why work on coreboot for GSoC 2017? =
  
* coreboot offers you the opportunity to work with on the . coreboot supports current silicon from AMD and Intel.  
+
* coreboot offers you the opportunity to work with various architectures right on the iron. coreboot supports both current and older silicon for a wide variety of chips and technologies.
 
* coreboot has a worldwide developer and user base.
 
* coreboot has a worldwide developer and user base.
* We are a very passionate team so you will interact directly with the project initiators and project leaders.  
+
* We are a very passionate team, so you will interact directly with the project initiators and project leaders.  
* We have a large, helpful community. coreboot has some extremely talented and helpful experts in firmware involved in the project. They are ready to assist and mentor students participating in GSoC 2013.
+
* We have a large, helpful community. coreboot has some extremely talented and helpful experts in firmware involved in the project. They are ready to assist and mentor students participating in GSoC.
 
* One of the last areas where open source software is not common is firmware. Running proprietary firmware can have severe effects on user's freedom and security. coreboot changes that by providing a common framework for initial hardware initialization and you can help us succeed.
 
* One of the last areas where open source software is not common is firmware. Running proprietary firmware can have severe effects on user's freedom and security. coreboot changes that by providing a common framework for initial hardware initialization and you can help us succeed.
<br/><br/>
 
  
 
= GSoC Student requirements =
 
= GSoC Student requirements =
Line 25: Line 26:
 
What will be required of you to be a coreboot GSoC student?
 
What will be required of you to be a coreboot GSoC student?
  
Google Summer of Code is a full (day)time job. This means we expect roughly 40 hours per week on your project, during the three months of coding. Obviously we have flexibility, but if your schedule (exams, courses) does not give you this amount of spare time, then maybe you should not apply.  
+
Google Summer of Code is a full-time job. This means we expect you to work roughly 40 hours per week on your project, during the three months of coding. Obviously we have flexibility, but if your schedule (exams, courses, other obligations) does not give you this amount of time, then you should not apply. We expect to be able to see this level of effort in student output.
  
# Prior to project acceptance, you have demonstrated that you can work with the coreboot codebase.  
+
== Before applying ==
#* By the time you have submitted your application, you should have downloaded, built and booted coreboot in QEMU, SimNow, or on real hardware. Please, email your serial output results to the mailing list.  
+
*Prior to project acceptance, you have demonstrated that you can work with the coreboot codebase.  
#* Send a patch to Gerrit for review. Check [[Easy projects]] or ask for simple tasks on the mailing list or on IRC.
+
:*By the time you have submitted your application, you should have downloaded, built and booted coreboot in QEMU, SimNow, or on real hardware. Please email your serial output results to the mailing list.  
# To pass and to be paid by Google requires that you meet certain milestones.  
+
:*Look over some of the development processes guidelines: [[git]], [https://review.coreboot.org/cgit/coreboot.git/plain/Documentation/gerrit_guidelines.md? Gerrit Etiquette and Guidelines], [[Development Guidelines]], and [[Developer Manual]]
#* First, you must be in good standing with the community before the official start of the program. We suggest you post some design emails to the mailing list, and get feedback on them, both before applying, and during the "community bonding period" between acceptance and official start.
+
:*Get signed up for gerrit and push at least one patch to Gerrit for review. Check [[Easy projects]] or ask for simple tasks on the mailing list or on chat.coreboot.org if you need ideas.
#* You must have made progress and committed significant code before the mid-term point and by the final.
+
:*Look through some patches on gerrit to get an understanding of the review process and common issues
# We require that accepted students to maintain a blog, where you will write about your project weekly. This is a way to measure progress and for the community at large to be able to help you. SoC is not a private contract between your mentor and you. http://blogs.coreboot.org/
+
*Before applying, you should also join the [https://www.coreboot.org/mailman/listinfo/coreboot mailing list] and [https://chat.coreboot.org chat.coreboot.org]. Introduce yourself and mention that you are a prospective GSoC student. Ask questions and discuss the project that you are considering. Community involvement is a key component of coreboot development.
# Student must be active on IRC and the mailing list.  
+
 
 +
== During the program ==
 +
* To pass and to be paid by Google requires that you meet certain milestones.  
 +
:* First, you must be in good standing with the community before the official start of the program. We expect you to post some design emails to the mailing list, and get feedback on them, both before applying, and during the "community bonding period" between acceptance and official start.
 +
:* You must have made progress and committed significant code before the mid-term point and by the final.
 +
:* We require that accepted students to maintain a blog, where you are expected to write about your project *WEEKLY*. This is a way to measure progress and for the community at large to be able to help you. GSoC is *NOT* a private contract between your mentor and you. [https://blogs.coreboot.org/ blogs.coreboot.org]
 +
* Student must be active in the community on chat.coreboot.org and the mailing list.
 +
* Students are expected to work on development publicly, and to push commits to the project on a regular basis. Depending on the project and what your mentor agrees to, these can be published directly to the project or to a public repository such as gitlab or github. If you are not publishing directly to the project codebase, be aware that we do not want large dumps of code that need to be rushed to meet the mid-term and final goals.
  
 
We don't expect our students to be experts in our problem domain, but we don't want you to fail because some basic misunderstanding was in your way of completing the task.
 
We don't expect our students to be experts in our problem domain, but we don't want you to fail because some basic misunderstanding was in your way of completing the task.
<br/><br/>
 
  
 
= Projects =
 
= Projects =
 +
 
There are many development tasks available in coreboot. Please visit the following pages for some ideas or come up with your own idea.  
 
There are many development tasks available in coreboot. Please visit the following pages for some ideas or come up with your own idea.  
 
* [[Project Ideas|coreboot project ideas]]
 
* [[Project Ideas|coreboot project ideas]]
* [http://www.flashrom.org/GSoC flashrom project ideas]
+
<!-- * [https://www.flashrom.org/GSoC flashrom project ideas] -->
* [http://serialice.com/GSoC SerialICE project ideas]
+
* [https://serialice.com/GSoC SerialICE project ideas]
  
 
We keep a list of [[previous GSoC Projects]] which might be of interest to you to see what others have accomplished.
 
We keep a list of [[previous GSoC Projects]] which might be of interest to you to see what others have accomplished.
Similarly the [http://blogs.coreboot.org/blog/category/gsoc/ blog posts related to previous GSoC projects] might give some insights to what it is like to be a coreboot GSoC student.
+
Similarly the [https://blogs.coreboot.org/blog/category/gsoc/ blog posts related to previous GSoC projects] might give some insights to what it is like to be a coreboot GSoC student.
<br/><br/>
 
  
 
== Your own Project Ideas ==
 
== Your own Project Ideas ==
Line 53: Line 60:
 
We have come up with some ideas for cool Summer of Code projects. These are projects that we think can be managed in the short period of GSoC, and they cover areas where coreboot is trying to reach new users and new use cases.
 
We have come up with some ideas for cool Summer of Code projects. These are projects that we think can be managed in the short period of GSoC, and they cover areas where coreboot is trying to reach new users and new use cases.
  
But of course your application does not need to be based on any of the ideas listed. The opposite: Maybe you have a great idea that we just didn't think of yet. Please let us know!
+
Of course your application does not need to be based on any of the ideas listed. The opposite: Maybe you have a great idea that we just didn't think of yet. Please let us know!
<br/><br/>
 
  
= Mentors =
+
= coreboot Summer of Code Application =
  
The following coreboot developers have volunteered to be GSoC mentors. Please stop by IRC and say hi to them and ask them questions about coreboot.
+
coreboot welcomes students from all backgrounds and levels of experience.  
  
{| class="wikitable"
+
Your application should include a complete project proposal. You should document that you have the knowledge and the ability to complete your proposed project. This may require a little research and understanding of coreboot prior to sending your application. The community and coreboot project mentors are your best resource in fleshing out your project ideas and helping with a project timeline. We recommend that you get feedback and recommendations on your proposal before the application deadline.
|-
 
! Name !! Role !! Comms
 
|-
 
| [[User:MJones|Marc Jones]] || coreboot:  co-organizer and mentor  || IRC: marcj
 
|-
 
| [[User:PatrickGeorgi|Patrick Georgi]] || coreboot: co-organizer and mentor || IRC: patrickg, pgeorgi
 
|-
 
| [[User:Stepan|Stefan Reinauer]] || coreboot/serialice:  mentor  || IRC: stepan
 
|-
 
| [[User:Dhendrix|David Hendricks]] || flashrom: possible mentor || IRC: dhendrix, [http://www.flashrom.org/mailman/listinfo/flashrom flashrom ML]
 
|-
 
| [http://www.flashrom.org/User:Roysjosh Joshua Roys] || flashrom: possible mentor || IRC: roysjosh
 
|-
 
| [[User:ruik|Rudolf Marek]] || coreboot: possible mentor || IRC: ruik
 
|-
 
| [[User:Jason Wang|QingPei Wang]] || coreboot: possible mentor || IRC:QingPei
 
|-
 
| [[User:MartinRoth|Martin Roth]] || coreboot: possible mentor || IRC: martinr
 
|-
 
| [http://www.flashrom.org/User:Hailfinger Carl-Daniel Hailfinger] || flashrom: possible mentor || IRC: carldani
 
|-
 
|}
 
 
 
'''Note to mentors:''' Each accepted project will have a lead mentor and a backup mentor. We will match mentors and students based on the project, experience level, and geographic location (native language, culture and time zone).
 
<br/><br/>
 
 
 
= coreboot Summer of Code Application =
 
  
 
Please complete the standard Google SoC application and project proposal. Prospective coreboot GSoC student should provide the following information as part of their application. If you are applying for a flashrom or SerialICE project use common sense when using the template below, this is part of the test. ;)
 
Please complete the standard Google SoC application and project proposal. Prospective coreboot GSoC student should provide the following information as part of their application. If you are applying for a flashrom or SerialICE project use common sense when using the template below, this is part of the test. ;)
  
 +
=== Personal Information ===
 
:Name:
 
:Name:
 
:Email:
 
:Email:
:IM/IRC/Skype/other contact:
+
:Phone number:
 
+
:chat/IM/IRC/Skype/other contact:
 
:Country/Timezone:
 
:Country/Timezone:
 +
:Normal working hours(UTC):
 
:School:
 
:School:
 
:Degree Program:
 
:Degree Program:
 
:Expected graduation date:
 
:Expected graduation date:
 +
:Short bio / overview of your background:
 +
:What are your other time commitments? Do you have a job, classes, vacations? When and how long?
  
:Most students have some time off planned during GSoC. Do you have any vacations? When and how long?
+
=== Software experience ===
 
+
:Github / Web Page / Blog / Microblog / Portfolio:
coreboot welcomes students from all backgrounds and levels of experience. To be seriously considered for coreboot GSoC, we recommend joining the mailing list and IRC channel. Introduce yourself and mention that you are a prospective GSoC student. Ask questions and discuss the project that you are considering. Community involvement is a key component of coreboot development. By the time you have submitted your application, you should have downloaded, built a and booted coreboot in QEMU, SimNow, or on real hardware. Please, email your serial output results to the mailing list.  
+
:Links to one or more patches submitted to the project you're applying for:
 
+
:Links to posts on the mailing list with the serial output of your build: [https://www.coreboot.org/pipermail/coreboot/ Mailing List Archives]
The following information will help coreboot match students with mentors and projects.
+
:Please comment on your software and firmware experience.
 
+
:Have you contributed to an open source project? Which one? What was your experience?
Please comment on your software and firmware experience.
+
:Did you build and run coreboot? Did you have problems?
 
 
Have you participated in the coreboot community before?
 
 
 
Have you contributed to an open source project? Which one? What was your experience?
 
 
 
Have you built and run coreboot? Did you have problems?
 
  
Did you find and fix a coreboot bug? Did you send a patch to Gerrit? Please provide a link to the Gerrit page.
+
=== Your project ===
 +
: Please provide an overview of your project (in your own words).
 +
:: Provide break down of your project in small specific weekly goals. Think about the potential timeline.
 +
:: How will you accomplish this goal? What is your working style?
 +
:: Explain what risks or potential problems your project might experience.
 +
:: What would you expect as a minimum level of success?
 +
:: Do you have a stretch goal?
  
Please provide an overview of your project and a break down of your project in small specific goals. Think about the potential timeline. Explain what risks or potential problems your project might experience. What would you expect as a minimum level of success? Do you have a stretch goal?
+
=== Other ===
<br/><br/>
+
:Resume (optional):
  
 
== Advice on how to apply ==
 
== Advice on how to apply ==
 +
* The Drupal project has a great page on [https://www.drupal.org/node/59037 how to write an SOC application].
 +
* GSoC Student Guide: [http://en.flossmanuals.net/GSoCStudentGuide/]
 +
* Secrets for GSoC success: [http://softwareswirl.blogspot.com/2014/03/my-secret-tip-for-gsoc-success.html]
  
Your application should include a complete project proposal. You should document that you have the knowledge and the ability to complete your proposed project. This may require a little research and understanding of coreboot prior to sending your application. Mentors are your best resource in flushing out your project ideas and helping with a project timeline. We recommend that you get feedback and recommendations on your proposal before the application deadline.
+
= Mentors =
  
The Drupal project has a great page on [http://drupal.org/node/59037 how to write an SOC application].
+
Each accepted project will have a lead mentor and a backup mentor. We will match mentors and students based on the project, experience level, and geographic location (native language, culture and time zone).
  
Please also read Google's [http://code.google.com/p/google-summer-of-code/wiki/AdviceforStudents Advice for Students].
+
Summer of Code primary mentors, are expected to stay in frequent contact with the student and provide guidance such as code reviews, pointers to useful documentation, etc. This should generally be a time commitment of one to two hours a week.
<br/><br/>
 
  
== Important dates ==
+
Backup mentors are expected to coordinate with the primary mentor and student on a regular basis, and keep track of the student process.  They should be work with the primary mentor and be available to take over mentoring duty if the primary mentor is unavailable (vacations, sickness, emergencies).
  
+
== Volunteering to be a mentor ==
* April 8: List of accepted mentoring organizations published on the Google Summer of Code 2013 site.
 
be student participants discuss application ideas with mentoring organizations.
 
* April 22: Student application period opens.
 
* May 3: Student application deadline.
 
  
The official timetable can be found [http://www.google-melange.com/gsoc/events/google/gsoc2013 here].
+
If you'd like to volunteer to be a mentor, please read the [https://developers.google.com/open-source/gsoc/resources/manual#mentor_manual GSoC Mentor Manual].  This will give you a better idea of expectations, and where to go for help.
 +
After that, contact Martin or Patrick and let them know that you're interested.
  
<font size= 1>All deadlines end at 19:00 [http://en.wikipedia.org/wiki/UTC UTC].</font size>
+
The following coreboot developers have volunteered to be GSoC 2017 mentors. Please stop by [https://chat.coreboot.org chat.coreboot.org] and say hi to them and ask them questions.
  
=== Past deadlines ===
+
{| class="wikitable"
* March 29: Mentoring organization application deadline.
+
|-
 +
! Name !! Role !! Comms !! AFK / Vacation MMDD-MMDD
 +
|-
 +
| [[User:MartinRoth|Martin Roth]] || coreboot: co-organizer and mentor || chat: martinr Email: gaumless@gmail.com|| No dates yet
 +
|-
 +
| [[User:PatrickGeorgi|Patrick Georgi]] || coreboot: co-organizer and mentor || chat: patrickg, pgeorgi ||
 +
|-
 +
| [[User:Stepan|Stefan Reinauer]] || coreboot/serialice:  mentor  || chat: stepan ||
 +
|-
 +
| [[User:Rminnich|Ron Minnich]] || coreboot: mentor || chat: rminnich ||
 +
|-
 +
|}

Latest revision as of 10:05, 21 January 2017

coreboot is applying for Google Summer of Code 2017 as a mentoring organization. It is not assumed that we are accepted yet. We will announce this on the mailing list, chat.coreboot.org and update this page when we are informed on 27 February.

coreboot has many Project Ideas for various ability levels. The coreboot project also acts as an umbrella organization for other open-source firmware related projects.

Official student application period in 2017 is from March 20 to April 3, with results announced on April 4. For the complete timeline, please see the GSoC 2017 timeline.


coreboot contacts

If you are interested in participating in GSoC as a student student, please visit chat.coreboot.org. Working closely with the community is highly encouraged, as we've seen that our most successful students are generally very involved.

Patrick Georgi and Martin Roth are the coreboot GSoC admins for 2017. Please feel free to reach out to them directly if you have any questions.

Why work on coreboot for GSoC 2017?

  • coreboot offers you the opportunity to work with various architectures right on the iron. coreboot supports both current and older silicon for a wide variety of chips and technologies.
  • coreboot has a worldwide developer and user base.
  • We are a very passionate team, so you will interact directly with the project initiators and project leaders.
  • We have a large, helpful community. coreboot has some extremely talented and helpful experts in firmware involved in the project. They are ready to assist and mentor students participating in GSoC.
  • One of the last areas where open source software is not common is firmware. Running proprietary firmware can have severe effects on user's freedom and security. coreboot changes that by providing a common framework for initial hardware initialization and you can help us succeed.

GSoC Student requirements

What will be required of you to be a coreboot GSoC student?

Google Summer of Code is a full-time job. This means we expect you to work roughly 40 hours per week on your project, during the three months of coding. Obviously we have flexibility, but if your schedule (exams, courses, other obligations) does not give you this amount of time, then you should not apply. We expect to be able to see this level of effort in student output.

Before applying

  • Prior to project acceptance, you have demonstrated that you can work with the coreboot codebase.
  • By the time you have submitted your application, you should have downloaded, built and booted coreboot in QEMU, SimNow, or on real hardware. Please email your serial output results to the mailing list.
  • Look over some of the development processes guidelines: git, Gerrit Etiquette and Guidelines, Development Guidelines, and Developer Manual
  • Get signed up for gerrit and push at least one patch to Gerrit for review. Check Easy projects or ask for simple tasks on the mailing list or on chat.coreboot.org if you need ideas.
  • Look through some patches on gerrit to get an understanding of the review process and common issues
  • Before applying, you should also join the mailing list and chat.coreboot.org. Introduce yourself and mention that you are a prospective GSoC student. Ask questions and discuss the project that you are considering. Community involvement is a key component of coreboot development.

During the program

  • To pass and to be paid by Google requires that you meet certain milestones.
  • First, you must be in good standing with the community before the official start of the program. We expect you to post some design emails to the mailing list, and get feedback on them, both before applying, and during the "community bonding period" between acceptance and official start.
  • You must have made progress and committed significant code before the mid-term point and by the final.
  • We require that accepted students to maintain a blog, where you are expected to write about your project *WEEKLY*. This is a way to measure progress and for the community at large to be able to help you. GSoC is *NOT* a private contract between your mentor and you. blogs.coreboot.org
  • Student must be active in the community on chat.coreboot.org and the mailing list.
  • Students are expected to work on development publicly, and to push commits to the project on a regular basis. Depending on the project and what your mentor agrees to, these can be published directly to the project or to a public repository such as gitlab or github. If you are not publishing directly to the project codebase, be aware that we do not want large dumps of code that need to be rushed to meet the mid-term and final goals.

We don't expect our students to be experts in our problem domain, but we don't want you to fail because some basic misunderstanding was in your way of completing the task.

Projects

There are many development tasks available in coreboot. Please visit the following pages for some ideas or come up with your own idea.

We keep a list of previous GSoC Projects which might be of interest to you to see what others have accomplished. Similarly the blog posts related to previous GSoC projects might give some insights to what it is like to be a coreboot GSoC student.

Your own Project Ideas

We have come up with some ideas for cool Summer of Code projects. These are projects that we think can be managed in the short period of GSoC, and they cover areas where coreboot is trying to reach new users and new use cases.

Of course your application does not need to be based on any of the ideas listed. The opposite: Maybe you have a great idea that we just didn't think of yet. Please let us know!

coreboot Summer of Code Application

coreboot welcomes students from all backgrounds and levels of experience.

Your application should include a complete project proposal. You should document that you have the knowledge and the ability to complete your proposed project. This may require a little research and understanding of coreboot prior to sending your application. The community and coreboot project mentors are your best resource in fleshing out your project ideas and helping with a project timeline. We recommend that you get feedback and recommendations on your proposal before the application deadline.

Please complete the standard Google SoC application and project proposal. Prospective coreboot GSoC student should provide the following information as part of their application. If you are applying for a flashrom or SerialICE project use common sense when using the template below, this is part of the test. ;)

Personal Information

Name:
Email:
Phone number:
chat/IM/IRC/Skype/other contact:
Country/Timezone:
Normal working hours(UTC):
School:
Degree Program:
Expected graduation date:
Short bio / overview of your background:
What are your other time commitments? Do you have a job, classes, vacations? When and how long?

Software experience

Github / Web Page / Blog / Microblog / Portfolio:
Links to one or more patches submitted to the project you're applying for:
Links to posts on the mailing list with the serial output of your build: Mailing List Archives
Please comment on your software and firmware experience.
Have you contributed to an open source project? Which one? What was your experience?
Did you build and run coreboot? Did you have problems?

Your project

Please provide an overview of your project (in your own words).
Provide break down of your project in small specific weekly goals. Think about the potential timeline.
How will you accomplish this goal? What is your working style?
Explain what risks or potential problems your project might experience.
What would you expect as a minimum level of success?
Do you have a stretch goal?

Other

Resume (optional):

Advice on how to apply

Mentors

Each accepted project will have a lead mentor and a backup mentor. We will match mentors and students based on the project, experience level, and geographic location (native language, culture and time zone).

Summer of Code primary mentors, are expected to stay in frequent contact with the student and provide guidance such as code reviews, pointers to useful documentation, etc. This should generally be a time commitment of one to two hours a week.

Backup mentors are expected to coordinate with the primary mentor and student on a regular basis, and keep track of the student process. They should be work with the primary mentor and be available to take over mentoring duty if the primary mentor is unavailable (vacations, sickness, emergencies).

Volunteering to be a mentor

If you'd like to volunteer to be a mentor, please read the GSoC Mentor Manual. This will give you a better idea of expectations, and where to go for help. After that, contact Martin or Patrick and let them know that you're interested.

The following coreboot developers have volunteered to be GSoC 2017 mentors. Please stop by chat.coreboot.org and say hi to them and ask them questions.

Name Role Comms AFK / Vacation MMDD-MMDD
Martin Roth coreboot: co-organizer and mentor chat: martinr Email: gaumless@gmail.com No dates yet
Patrick Georgi coreboot: co-organizer and mentor chat: patrickg, pgeorgi
Stefan Reinauer coreboot/serialice: mentor chat: stepan
Ron Minnich coreboot: mentor chat: rminnich