Forum | Documentation | Website | Blog

Skip to content
Snippets Groups Projects
template.rst 10.3 KiB
Newer Older
Deepak Khatri's avatar
Deepak Khatri committed
.. _gsoc-proposal-template:
Deepak Khatri's avatar
Deepak Khatri committed

Proposal template 
#################

Introduction
*************

Deepak Khatri's avatar
Deepak Khatri committed
Summary links
=============

- **Contributor:** `Ayush Singh <https://forum.beagleboard.org/u/ayush1325>`_
- **Mentors:** `Jason Kridner <https://forum.beagleboard.org/u/jkridner>`_, `Vaishnav Acath <https://forum.beagleboard.org/u/vaishnav>`_
Deepak Khatri's avatar
Deepak Khatri committed
- **Code:** `Google Summer of Code / greybus / cc1352-firmware · GitLab <https://openbeagle.org/gsoc/greybus/cc1352-firmware>`_
- **Documentation:** `Ayush Singh / docs.beagleboard.io · GitLab <https://openbeagle.org/ayush1325/docs.beagleboard.io>`_
- **GSoC:** `Google Summer of Code <https://summerofcode.withgoogle.com/archive/2023/projects/iTfGBkDk>`_ 
Deepak Khatri's avatar
Deepak Khatri committed

Deepak Khatri's avatar
Deepak Khatri committed
Status
=======

Deepak Khatri's avatar
Deepak Khatri committed
This project is currently just a proposal.

Proposal
========

Please complete the requirements listed on :ref:`gsoc-contributor-guide` 
Deepak Khatri's avatar
Deepak Khatri committed
and fill out this template.

Deepak Khatri's avatar
Deepak Khatri committed
About 
=====

Deepak Khatri's avatar
Deepak Khatri committed
- **Forum:** :fab:`discourse` `u/ayush1325 (Ayush Singh) <https://forum.beagleboard.org/u/ayush1325>`_
- **OpenBeagle:** :fab:`gitlab` `ayush1325 (Ayush Singh) <https://openbeagle.org/ayush1325>`_
- **IRC:** :fas:`comments` `jkridner (Jason Kridner) <https://web.libera.chat/gamja/#beagle>`_
- **Github:** :fab:`github` `jadonk (Jason Kridner) <https://github.com/jadonk>`_
- **School:** :fas:`school` Greatest University
- **Country:** :fas:`flag` Worldistan
- **Primary language:** :fas:`language` Igpay Atinlay
- **Typical work hours:** :fas:`clock` 8AM-5PM US Eastern
- **Previous GSoC participation:** :fab:`google` N/A
Deepak Khatri's avatar
Deepak Khatri committed

Deepak Khatri's avatar
Deepak Khatri committed
Project
********

Deepak Khatri's avatar
Deepak Khatri committed
**Project name:** About my super cool project.
Deepak Khatri's avatar
Deepak Khatri committed

Deepak Khatri's avatar
Deepak Khatri committed
Description
============

Deepak Khatri's avatar
Deepak Khatri committed
In 10-20 sentences, what are you making, for whom, why and with what technologies 
(programming languages, etc.)? (We are looking for open source SOFTWARE submissions. By the way, Verilog for programming an FPGA is considered software by us.)
Deepak Khatri's avatar
Deepak Khatri committed

Deepak Khatri's avatar
Deepak Khatri committed
Software
=========

Deepak Khatri's avatar
Deepak Khatri committed
Which software or technology stack are you going to use to complete this project.
Deepak Khatri's avatar
Deepak Khatri committed

Deepak Khatri's avatar
Deepak Khatri committed
Hardware
========

Deepak Khatri's avatar
Deepak Khatri committed
A list of hardware that you are going to use for this project.
Deepak Khatri's avatar
Deepak Khatri committed

Timeline
********

Deepak Khatri's avatar
Deepak Khatri committed
Provide a development timeline with 10 milestones, one for each week of development without 
an evaluation, and any pre-work. (A realistic, measurable timeline is critical to our selection process.)

.. note:: This timeline is based on the `official GSoC timeline <https://developers.google.com/open-source/gsoc/timeline>`_


Timeline summary
=================

.. table:: 

    +------------------------+----------------------------------------------------------------------------------------------------+
    | Date                   | Activity                                                                                           |                                  
    +========================+====================================================================================================+
    | February 26            | Connect with possible mentors and request review on first draft                                    |
    +------------------------+----------------------------------------------------------------------------------------------------+
    | March 4                | Complete prerequisites, verify value to community and request review on second draft               |
    +------------------------+----------------------------------------------------------------------------------------------------+
    | March 11               | Finalized timeline and request review on final draft                                               |
    +------------------------+----------------------------------------------------------------------------------------------------+
    | March 21               | Submit application                                                                                 |
    +------------------------+----------------------------------------------------------------------------------------------------+
    | May 1                  | Start bonding                                                                                      |
    +------------------------+----------------------------------------------------------------------------------------------------+
    | May 27                 | Start coding and introductory video                                                                |
    +------------------------+----------------------------------------------------------------------------------------------------+
    | June 3                 | Release introductory video and complete milestone #1                                               |
    +------------------------+----------------------------------------------------------------------------------------------------+
    | June 10                | Complete milestone #2                                                                              |
    +------------------------+----------------------------------------------------------------------------------------------------+
    | June 17                | Complete milestone #3                                                                              |
    +------------------------+----------------------------------------------------------------------------------------------------+
    | June 24                | Complete milestone #4                                                                              |
    +------------------------+----------------------------------------------------------------------------------------------------+
    | July 1                 | Complete milestone #5                                                                              |
    +------------------------+----------------------------------------------------------------------------------------------------+
    | July 8                 | Submit midterm evaluations                                                                         |
    +------------------------+----------------------------------------------------------------------------------------------------+
    | July 15                | Complete milestone #6                                                                              |
    +------------------------+----------------------------------------------------------------------------------------------------+
    | July 22                | Complete milestone #7                                                                              |
    +------------------------+----------------------------------------------------------------------------------------------------+
    | July 29                | Complete milestone #8                                                                              |
    +------------------------+----------------------------------------------------------------------------------------------------+
    | August 5               | Complete milestone #9                                                                              |
    +------------------------+----------------------------------------------------------------------------------------------------+
    | August 12              | Complete milestone #10                                                                             |
    +------------------------+----------------------------------------------------------------------------------------------------+
    | August 19              | Submit final project video, submit final work to GSoC site and complete final mentor evaluation    |
    +------------------------+----------------------------------------------------------------------------------------------------+

Timeline detailed
=================
Deepak Khatri's avatar
Deepak Khatri committed

Deepak Khatri's avatar
Deepak Khatri committed
Community Bonding Period (May 1st - May 26th)
==============================================

GSoC contributors get to know mentors, read documentation, get up to speed to begin working on their projects

Coding begins (May 27th)
=========================

Deepak Khatri's avatar
Deepak Khatri committed
Milestone #1, Introductory YouTube video (June 3rd)
===================================================

Milestone #2 (June 10th)
Deepak Khatri's avatar
Deepak Khatri committed
==========================

Deepak Khatri's avatar
Deepak Khatri committed
Milestone #3 (June 17th)
=========================

Milestone #4 (June 24th)
Deepak Khatri's avatar
Deepak Khatri committed
==========================

Deepak Khatri's avatar
Deepak Khatri committed
Milestone #5 (July 1st)
========================

Submit midterm evaluations (July 8th)
=====================================
Deepak Khatri's avatar
Deepak Khatri committed

.. important:: 
    
    **July 12 - 18:00 UTC:** Midterm evaluation deadline (standard coding period) 

Deepak Khatri's avatar
Deepak Khatri committed
Milestone #6 (July 15th)
=========================

Milestone #7 (July 22nd)
Deepak Khatri's avatar
Deepak Khatri committed
=========================

Deepak Khatri's avatar
Deepak Khatri committed
Milestone #8 (July 29th)
=========================

Milestone #9 (Aug 5th)
Deepak Khatri's avatar
Deepak Khatri committed
=======================

Deepak Khatri's avatar
Deepak Khatri committed
Milestone #10 (Aug 12th)
Deepak Khatri's avatar
Deepak Khatri committed
========================

Deepak Khatri's avatar
Deepak Khatri committed
Final YouTube video (Aug 19th)
Deepak Khatri's avatar
Deepak Khatri committed
===============================

Deepak Khatri's avatar
Deepak Khatri committed
Submit final project video, submit final work to GSoC site 
and complete final mentor evaluation

Deepak Khatri's avatar
Deepak Khatri committed
Final Submission (Aug 24nd)
============================

.. important::

    **August 19 - 26 - 18:00 UTC:** Final week: GSoC contributors submit their final work 
    product and their final mentor evaluation (standard coding period)

    **August 26 - September 2 - 18:00 UTC:** Mentors submit final GSoC contributor 
    evaluations (standard coding period)

Initial results (September 3)
=============================

.. important:: 
    **September 3 - November 4:** GSoC contributors with extended timelines continue coding

    **November 4 - 18:00 UTC:** Final date for all GSoC contributors to submit their final work product and final evaluation

    **November 11 - 18:00 UTC:** Final date for mentors to submit evaluations for GSoC contributor projects with extended deadline

Deepak Khatri's avatar
Deepak Khatri committed
***********************

Deepak Khatri's avatar
Deepak Khatri committed
In 5-15 sentences, convince us you will be able to successfully complete your project in the timeline you have described.

Deepak Khatri's avatar
Deepak Khatri committed
Contingency
===========

Deepak Khatri's avatar
Deepak Khatri committed
What will you do if you get stuck on your project and your mentor isn’t around?

Deepak Khatri's avatar
Deepak Khatri committed
Benefit
Deepak Khatri's avatar
Deepak Khatri committed
========

Deepak Khatri's avatar
Deepak Khatri committed
If successfully completed, what will its impact be on the `BeagleBoard.org <https://www.beagleboard.org/>`_ community? Include quotes from `BeagleBoard.org <https://www.beagleboard.org/>`_.
community members who can be found on our `Discord <https://bbb.io/gsocchat>`_ and `BeagleBoard.org forum <https://bbb.io/gsocml/13>`_.
Deepak Khatri's avatar
Deepak Khatri committed
Please complete the requirements listed in the `General Requirements <https://forum.beagleboard.org/t/gsoc-ideas/35850#general-requirements-5>`_. 
Provide link to merge request.
Deepak Khatri's avatar
Deepak Khatri committed

Suggestions
===========

Is there anything else we should have asked you?